class KHelpMenu


Internal Use Only
Definition#include <khelpmenu.h>
InheritsQObject
Annotated List
Files
Globals
Hierarchy
Index
Main

Public Types

Public Methods

Public Slots

Signals


Detailed Description

the editor for a KListView. please don't use this.

enum MenuId {menuHelpContents = 0, menuWhatsThis = 1, menuAboutApp = 2, menuAboutKDE = 3, menuReportBug = 4 }

 KHelpMenu ( QWidget *parent=0, const QString &aboutAppText=QString::null, bool showWhatsThis=true )

Constructor.

Parameters:
parentThe parent of the dialog boxes. The boxes are modeless and will be centered with respect to the parent.
aboutAppTextUser definable string that is used in the application specific dialog box. Note: The help menu will not open this dialog box if you don't define a string. See showAboutApplication() for more information.
showWhatsThisDecides whether a "Whats this" entry will be added to the dialog.

 KHelpMenu ( QWidget *parent, const KAboutData *aboutData, bool showWhatsThis=true, KActionCollection *actions = 0 )

Constructor.

Parameters:
parentThe parent of the dialog boxes. The boxes are modeless and will be centered with respect to the parent.
aboutDataUser and app data used in the About app dialog
showWhatsThisDecides whether a "Whats this" entry will be added to the dialog.

KHelpMenu ()

Destructor

Destroys dialogs and the menu pointer retuned by menu

KPopupMenumenu ()

Returns a popup menu you can use in the menu bar or where you need it.

Note: This method will only create one instance of the menu. If you call this method twice or more the same pointer is returned

void  appHelpActivated ()

[slot]

Opens the help page for the application. The application name is used as a key to determine what to display and the system will attempt to open <appName>/index.html.

void  contextHelpActivated ()

[slot]

Activates What's This help for the application.

void  aboutApplication ()

[slot]

Opens an application specific dialog box. The dialog box will display the string that was defined in the constructor. If that string was empty the showAboutApplication() is emitted instead.

void  aboutKDE ()

[slot]

Opens the standard "About KDE" dialog box.

void  reportBug ()

[slot]

Opens the standard "Report Bugs" dialog box.

private slots: /** * Connected to the menu  pointer (if created) to detect a delete * operation on the pointer. You should not delete the pointer in your * code yourself. Let the KHelpMenu destructor do the job. */ void menuDestroyed()

[slot]

void  dialogFinished ()

[slot]

Connected to the dialogs (about kde and bug report) to detect when they are finished.

void  timerExpired ()

[slot]

This slot will delete a dialog (about kde or bug report) if the dialog pointer is not zero and the the dialog is not visible. This slot is activated by a one shot timer started in dialogHidden

void  showAboutApplication ()

[signal]

This signal is emitted from aboutApplication() if no "about application" string has been defined. The standard application specific dialog box that is normally activated in aboutApplication() will not be displayed when this signal is emitted.