KHelpMenu Class Reference

Standard KDE help menu with dialog boxes. More...

#include <khelpmenu.h>

Inheritance diagram for KHelpMenu:


Public Types
enum	MenuId { menuHelpContents = 0, menuWhatsThis = 1, menuAboutApp = 2, menuAboutKDE = 3, menuReportBug = 4, menuSwitchLanguage = 5 }
Public Slots
void	aboutApplication ()
void	aboutKDE ()
void	appHelpActivated ()
void	contextHelpActivated ()
void	reportBug ()
void	switchApplicationLanguage ()
Signals
void	showAboutApplication ()
Public Member Functions
	KHelpMenu (QWidget parent, const KAboutData aboutData, bool showWhatsThis=true, KActionCollection *actions=0)
	KHelpMenu (QWidget *parent=0, const QString &aboutAppText=QString::null, bool showWhatsThis=true)
KPopupMenu *	menu ()
	~KHelpMenu ()
Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Detailed Description

Standard KDE help menu with dialog boxes.

This class provides the standard KDE help menu with the default "about" dialog boxes and help entry.

This class is used in KMainWindow so normally you don't need to use this class yourself. However, if you need the help menu or any of its dialog boxes in your code that is not subclassed from KMainWindow you should use this class.

The usage is simple:

 mHelpMenu = new KHelpMenu( this, <someText> );
 kmenubar->insertItem(i18n("&Help"), mHelpMenu->menu() );

or if you just want to open a dialog box:

 mHelpMenu = new KHelpMenu( this, <someText> );
 connect( this, SIGNAL(someSignal()), mHelpMenu,SLOT(mHelpMenu->aboutKDE()));

IMPORTANT: The first time you use KHelpMenu::menu(), a KPopupMenu object is allocated. Only one object is created by the class so if you call KHelpMenu::menu() twice or more, the same pointer is returned. The class will destroy the popupmenu in the destructor so do not delete this pointer yourself.

The KHelpMenu object will be deleted when its parent is destroyed but you can delete it yourself if you want. The code below will always work.

 MyClass::~MyClass()
 {
   delete mHelpMenu;
 }

Using your own "about application" dialog box:

The standard "about application" dialog box is quite simple. If you need a dialog box with more functionality you must design that one yourself. When you want to display the dialog you can choose one of two methods. Common for both is that you must make a help menu object with no text argument If the text is missing the default dialog box will not be displayed:

Example 1 Using showAboutApplication signal (preferred)

 void MyClass::myFunc()
 {
   ..
   KHelpMenu *helpMenu = new KHelpMenu( this );
   connect( helpMenu, SIGNAL(showAboutApplication()),
          this, SLOT(myDialogSlot()));
   ..
 }

 void MyClass::myDialogSlot()
 {
   <activate your custom dialog>
 }

Example 2 Old style - connecting directly to the menu entry.

 void MyClass::myFunc()
 {
   KHelpMenu *helpMenu = new KHelpMenu( this );
   KPopupMenu *help = mHelpMenu->menu();
   help->connectItem( KHelpMenu::menuAboutApp, this, SLOT(myDialogSlot()) );
 }

 void MyClass::myDialogSlot()
 {
   <activate your custom dialog>
 }

Author:: Espen Sand (espen@kde.org)

Definition at line 131 of file khelpmenu.h.

Member Enumeration Documentation

enum KHelpMenu::MenuId

Enumerator:

menuHelpContents
menuWhatsThis
menuAboutApp
menuAboutKDE
menuReportBug
menuSwitchLanguage

Definition at line 136 of file khelpmenu.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters:

	parent	The parent of the dialog boxes. The boxes are modeless and will be centered with respect to the parent.
	aboutAppText	User 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.
	showWhatsThis	Decides whether a "Whats this" entry will be added to the dialog.

Definition at line 65 of file khelpmenu.cpp.

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

Constructor.

This alternative constructor is mainly useful if you want to overide the standard actions (aboutApplication(), aboutKDE(), helpContents(), reportBug, and optionally whatsThis).

Parameters:

	parent	The parent of the dialog boxes. The boxes are modeless and will be centered with respect to the parent.
	aboutData	User and app data used in the About app dialog
	showWhatsThis	Decides whether a "Whats this" entry will be added to the dialog.
	actions	KActionCollection that is used instead of the standard actions.

Definition at line 76 of file khelpmenu.cpp.

KHelpMenu::~KHelpMenu ( )

Destructor.

Destroys dialogs and the menu pointer retuned by menu

Definition at line 101 of file khelpmenu.cpp.

Member Function Documentation

void KHelpMenu::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.

Definition at line 192 of file khelpmenu.cpp.

void KHelpMenu::aboutKDE ( ) [slot]

Opens the standard "About KDE" dialog box.

Definition at line 236 of file khelpmenu.cpp.

void KHelpMenu::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.

Definition at line 186 of file khelpmenu.cpp.

void KHelpMenu::contextHelpActivated ( ) [slot]

Activates What's This help for the application.

Definition at line 304 of file khelpmenu.cpp.

KPopupMenu * KHelpMenu::menu ( )

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

Definition at line 111 of file khelpmenu.cpp.

void KHelpMenu::reportBug ( ) [slot]

Opens the standard "Report Bugs" dialog box.

Definition at line 247 of file khelpmenu.cpp.

void KHelpMenu::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.

void KHelpMenu::switchApplicationLanguage ( ) [slot]

Opens changing default application language dialog box.

Definition at line 257 of file khelpmenu.cpp.

void KHelpMenu::virtual_hook	(	int	id,
		void *	data
	)			`[protected, virtual]`

Definition at line 316 of file khelpmenu.cpp.

The documentation for this class was generated from the following files:

kdeui

KHelpMenu Class Reference

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kdeui

API Reference