Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

help_controller.h

Go to the documentation of this file.
      00001 //----------------------------------------------------------------------------------------
      00011 // RCS-ID:      $Id: import_controller.h,v 1.1 2002/08/27 05:06:04 robertoconnor Exp $
      00012 //----------------------------------------------------------------------------------------
      00013 
      00014 //----------------------------------------------------------------------------------------
      00015 // Begin single inclusion of this .h file condition
      00016 //----------------------------------------------------------------------------------------
      00017 
      00018 #ifndef _HELP_CONTROLLER_H_
      00019 #define _HELP_CONTROLLER_H_
      00020 
      00021 //----------------------------------------------------------------------------------------
      00022 // GCC interface
      00023 //----------------------------------------------------------------------------------------
      00024 
      00025 #if defined(__GNUG__) && ! defined(__APPLE__)
      00026     #pragma interface "help_controller.h"
      00027 #endif
      00028 
      00029 //----------------------------------------------------------------------------------------
      00030 // Shared defines
      00031 //----------------------------------------------------------------------------------------
      00032 
      00033 #include "plucker_defines.h"
      00034 
      00035 //----------------------------------------------------------------------------------------
      00036 // Begin feature removal condition
      00037 //----------------------------------------------------------------------------------------
      00038 
      00039 #if ( setupUSE_ONLINE_HELP )
      00040 
      00041 //----------------------------------------------------------------------------------------
      00042 // Headers
      00043 //----------------------------------------------------------------------------------------
      00044 
      00045 #include "wx/html/helpctrl.h"
      00046 #include "wx/confbase.h"
      00047 #include "wx/fileconf.h"
      00048 
      00049 //----------------------------------------------------------------------------------------
      00050 // Class definition: help_controller
      00051 //----------------------------------------------------------------------------------------
      00052 
      00054 class help_controller : public wxHtmlHelpController
00055 {
00056 
00057     // I guess one doesn't use DECLARE_DYNAMIC_CLASS on these.
00058     
00059 public:
00060 
00062 
00065     help_controller();
00066 
00068     ~help_controller();
00069 
00071 
00075     static help_controller* get( bool create_on_demand = TRUE );
00076     
00078 
00081     static help_controller* set( help_controller* desired_help_controller );
00082 
00084 
00088     void add_book( const wxString& help_fullname );
00089     
00091 
00095     void show_help_topic( const wxString& topic );
00096     
00098 
00101     void show_help();
00102     
00104 
00109     void search_help( wxWindow* parent );
00110     
00112 
00116     void close();
00117 
00118 private:
00119     
00120     // Singleton instance:
00121     static help_controller* ms_instance; 
00122     
00123     // Config file to store help settings.
00124     wxFileConfig*           m_help_configuration;  
00125     
00126 };
00127 
00128 //----------------------------------------------------------------------------------------
00129 // End feature removal condition
00130 //----------------------------------------------------------------------------------------
00131 
00132 #endif  // setupUSE_ONLINE_HELP
00133 
00134 //----------------------------------------------------------------------------------------
00135 // End single inclusion of this .h file condition
00136 //----------------------------------------------------------------------------------------
00137 
00138 #endif  //_HELP_CONTROLLER_H_