|
| | HelpViewer (QWidget *parent, const char *name=0) |
| |
| virtual | ~HelpViewer () |
| |
| virtual void | initializeWidget (MainControl &main_control) |
| |
| virtual void | onNotify (Message *message) |
| |
| virtual void | showHelp (const String &URL) |
| |
| virtual void | showHelp (const String &URL, String entry) |
| |
| void | setDefaultPage (const String &url) |
| |
| const String & | getDefaultPage () const |
| |
| void | setProject (const String &project) |
| |
| String | getProject () const |
| |
| void | setBaseDirectory (const String &dir) |
| |
| const String & | getBaseDirectory () const |
| |
| virtual void | registerForHelpSystem (const QObject *object, const String &docu_entry) |
| | Register a widget for showing its documentation. More...
|
| |
| void | unregisterForHelpSystem (const QObject *object) |
| | Unregister a widget for showing its documentation. More...
|
| |
| bool | showHelpFor (const QObject *object) |
| | Show the documentation entry for a given widget. More...
|
| |
| bool | showDocumentationForObject () |
| | Show documentation for object under cursor. More...
|
| |
| bool | hasHelpFor (const QObject *object) const |
| | Check wheter we have a documentation entry for a given object. More...
|
| |
| String | getHelpEntryFor (const QObject *object) const |
| | Get help entry for widget. More...
|
| |
| void | setWhatsThisEnabled (bool state) |
| |
| bool | isWhatsThisEnabled () const |
| |
| void | showDocumentationFor (const String &classname, const String &member) |
| |
| | DockWidget (QWidget *parent, const char *title=0) |
| | Use this constructor! More...
|
| |
| virtual | ~DockWidget () |
| |
| void | setGuest (QWidget &guest) |
| |
| virtual void | fetchPreferences (INIFile &inifile) |
| |
| virtual void | writePreferences (INIFile &inifile) |
| |
| virtual void | setWidgetVisible (bool state) |
| | For usage with Python: More...
|
| |
| QGridLayout * | getGuestLayout () |
| |
| void | setWorkingDirFromFilename_ (String filename) |
| |
| | ModularWidget (const char *name="<ModularWidget>") |
| |
| | ModularWidget (const ModularWidget &widget) |
| |
| virtual | ~ModularWidget () |
| |
| virtual void | destroy () |
| |
| virtual void | clear () |
| |
| virtual void | checkMenu (MainControl &main_control) |
| |
| QAction * | insertMenuEntry (Position parent_id, const QString &name, const QObject *receiver=0, const char *slot=0, const String &description="", QKeySequence accel=QKeySequence(), const QString &menu_hint=QString(""), UIOperationMode::OperationMode minimal_mode=UIOperationMode::MODE_ALL) |
| |
| void | setMenuHelp (QAction *action, const String &url) |
| |
| virtual void | addToolBarEntries (QToolBar *main_tb) |
| |
| void | setIcon (QAction *action, const String &filename, bool add_to_main_toolbar=true) |
| |
| virtual void | initializePreferencesTab (Preferences &preferences) |
| |
| virtual void | finalizePreferencesTab (Preferences &preferences) |
| |
| virtual void | applyPreferences () |
| |
| bool | lockComposites () |
| |
| bool | unlockComposites () |
| | Unlock the Composites. More...
|
| |
| MainControl * | getMainControl () const |
| |
| virtual void | setStatusbarText (const String &text, bool important=false) |
| |
| virtual void | setStatusbarText (const QString &text, bool important=false) |
| |
| String | getWorkingDir () |
| | Implemented for convenience. More...
|
| |
| void | setWorkingDir (const String &dir) |
| | Implemented for convenience. More...
|
| |
| FragmentDB & | getFragmentDB () const |
| |
| virtual void | dump (std::ostream &s=std::cout, Size depth=0) const |
| |
| virtual void | finalizeWidget (MainControl &main_control) |
| |
| virtual bool | canHandle (const String &) const |
| |
| virtual bool | openFile (const String &) |
| |
| | Embeddable (const String &identifier="<Embeddable>") |
| |
| | Embeddable (const Embeddable &embeddable) |
| |
| virtual | ~Embeddable () |
| |
| void | setIdentifier (const String &identifier) |
| |
| const String & | getIdentifier () const |
| |
| void | unregisterThis () |
| |
| virtual void | registerThis () |
| |
| | ConnectionObject () |
| |
| virtual | ~ConnectionObject () |
| |
| void | registerConnectionObject (ConnectionObject &object) |
| |
| void | unregisterConnectionObject (ConnectionObject &object) |
| |
| bool | isConnectionObjectRegistered (const ConnectionObject &object) |
| |
| ConnectionObject * | getParent () const |
| |
| ConnectionObject * | getRoot () |
| |
| virtual bool | isValid () const |
| |
DockWidget to show online help texts e.g. the BALLView documentation The documentation for BALLView was written in the HTML format, such that it either be used online from the project's website or inside the program itself. To obtain help for individual elements in the graphical user interface a special mode was added. In the "Help" menu the entry "Whats this?" will switch into this mode and transform the mouse cursor into a question mark. While the "Whats this?" mode is active a left mouse click on any widget will open the corresponding help entry in the documentation. (If no help entry for that widget exists nothing will happen.) To leave the "Whats this?" mode just press the right mouse button or press the "Escape" key. As an alternative for this approach the "F1" key will popup the documentation for the current widget under the mouse cursor.
To show a specific help page, just call ModularWidget::showHelp(String) or send a ShowHelpMessage. Per default the HelpViewer looks for index.html in $BALL_DATA_PATH/../doc/BALLView . You can change this behavior by using setDefaultDir() and setDefaultPage(). Links to pages on the WWW wont work! QWidgets and menu entries can be registered with a link into the HTML documentation. See registerWidgetForHelpSystem. The implemention for opening the documentation per "Whats this?" menu entry and the hotkey "F1" is also done here.
Definition at line 66 of file helpViewer.h.
Public Slots inherited from BALL::VIEW::DockWidget
1.8.7