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

#include <khelpmenu.h>

Inheritance diagram for KisKHelpMenu:

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
QAction *	action (MenuId id) const

	KisKHelpMenu (QWidget *parent, const KAboutData &aboutData, bool showWhatsThis=true)

	KisKHelpMenu (QWidget *parent=0, const QString &aboutAppText=QString(), bool showWhatsThis=true)

QMenu *	menu ()

	~KisKHelpMenu () override

Private Slots
void	dialogFinished ()

void	menuDestroyed ()

void	timerExpired ()

Private Attributes
KisKHelpMenuPrivate *const	d

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 KisKMainWindow 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 KisKMainWindow you should use this class.

The usage is simple:

mHelpMenu = new KisKHelpMenu( this, <someText> );

kmenubar->addMenu(mHelpMenu->menu() );

KisKHelpMenu::KisKHelpMenu

KisKHelpMenu(QWidget *parent=0, const QString &aboutAppText=QString(), bool showWhatsThis=true)

Definition khelpmenu.cpp:81

or if you just want to open a dialog box:

mHelpMenu = new KisKHelpMenu( this, <someText> );

connect( this, SIGNAL(someSignal()), mHelpMenu,SLOT(aboutKDE()));

connect

connect(this, SIGNAL(optionsChanged()), this, SLOT(saveOptions()))

KisKHelpMenu::aboutKDE

void aboutKDE()

Definition khelpmenu.cpp:223

IMPORTANT: The first time you use KisKHelpMenu::menu(), a QMenu object is allocated. Only one object is created by the class so if you call KisKHelpMenu::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 KisKHelpMenu 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 simply need to connect the help menu signal showAboutApplication() to your slot.

void MyClass::myFunc()
{
  ..
  KisKHelpMenu *helpMenu = new KisKHelpMenu( this );
  connect( helpMenu, SIGNAL(showAboutApplication()),
         this, SLOT(myDialogSlot()));
  ..
}
 
void MyClass::myDialogSlot()
{
  <activate your custom dialog>
}

KDE Help Menu

[KDE Action Restrictions][$i]
actions/help_contents=false
actions/help_whats_this=false
actions/help_report_bug=false
actions/switch_application_language=false
actions/help_about_app=false
actions/help_about_kde=false

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

Definition at line 105 of file khelpmenu.h.

Member Enumeration Documentation

◆ MenuId

enum KisKHelpMenu::MenuId

Enumerator
menuHelpContents
menuWhatsThis
menuAboutApp
menuAboutKDE
menuReportBug
menuSwitchLanguage

Definition at line 160 of file khelpmenu.h.

                {
        menuHelpContents = 0,
        menuWhatsThis = 1,
        menuAboutApp = 2,
        menuAboutKDE = 3,
        menuReportBug = 4,
        menuSwitchLanguage = 5
    };

Constructor & Destructor Documentation

◆ KisKHelpMenu() [1/2]

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

explicit

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 default application dialog box.
showWhatsThis	Decides whether a "Whats this" entry will be added to the dialog.

Definition at line 81 of file khelpmenu.cpp.

    : QObject(parent), d(new KisKHelpMenuPrivate)
{
    d->mAboutAppText = aboutAppText;
    d->mShowWhatsThis = showWhatsThis;
    d->mParent = parent;
    d->createActions(this);
}

References KisKHelpMenuPrivate::createActions(), d, KisKHelpMenuPrivate::mAboutAppText, KisKHelpMenuPrivate::mParent, and KisKHelpMenuPrivate::mShowWhatsThis.

◆ KisKHelpMenu() [2/2]

KisKHelpMenu::KisKHelpMenu	(	QWidget *	parent,
		const KAboutData &	aboutData,
		bool	showWhatsThis = true )

Constructor.

This alternative constructor is mainly useful if you want to override 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.

Definition at line 91 of file khelpmenu.cpp.

    : QObject(parent), d(new KisKHelpMenuPrivate)
{
    d->mShowWhatsThis = showWhatsThis;
    d->mParent = parent;
    d->mAboutData = aboutData;
    d->createActions(this);
}

References KisKHelpMenuPrivate::createActions(), d, KisKHelpMenuPrivate::mAboutData, KisKHelpMenuPrivate::mParent, and KisKHelpMenuPrivate::mShowWhatsThis.

◆ ~KisKHelpMenu()

KisKHelpMenu::~KisKHelpMenu ( )

override

Destructor

Destroys dialogs and the menu pointer returned by menu

Definition at line 101 of file khelpmenu.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ aboutApplication

void KisKHelpMenu::aboutApplication ( )

slot

Opens an application specific dialog box.

The method will try to open the about box using the following steps:

If the showAboutApplication() signal is connected, then it will be called. This means there is an application defined aboutBox.
If the aboutData was set in the constructor a KAboutApplicationDialog will be created.
Else a default about box using the aboutAppText from the constructor will be created.

Definition at line 216 of file khelpmenu.cpp.

{
    if (receivers(SIGNAL(showAboutApplication())) > 0) {
        Q_EMIT showAboutApplication();
    }
}

References showAboutApplication().

◆ aboutKDE

void KisKHelpMenu::aboutKDE ( )

slot

Opens the standard "About KDE" dialog box.

Definition at line 223 of file khelpmenu.cpp.

{
    if (!d->mAboutKDE) {
        d->mAboutKDE = new KisKAboutKdeDialog(d->mParent);
        connect(d->mAboutKDE, SIGNAL(finished(int)), this, SLOT(dialogFinished()));
    }
    d->mAboutKDE->show();
}

References connect(), d, dialogFinished(), KisKHelpMenuPrivate::mAboutKDE, and KisKHelpMenuPrivate::mParent.

◆ action()

QAction * KisKHelpMenu::action ( MenuId id ) const

Returns the QAction * associated with the given parameter Will return 0 pointers if menu() has not been called

Parameters

id	The id of the action of which you want to get QAction *

Definition at line 180 of file khelpmenu.cpp.

{
    switch (id) {
    case menuHelpContents:
        return d->mHandBookAction;
        break;
 
    case menuWhatsThis:
        return d->mWhatsThisAction;
        break;
 
    case menuReportBug:
        return d->mReportBugAction;
        break;
 
    case menuSwitchLanguage:
        return d->mSwitchApplicationLanguageAction;
        break;
 
    case menuAboutApp:
        return d->mAboutAppAction;
        break;
 
    case menuAboutKDE:
        return d->mAboutKDEAction;
        break;
    }
 
    return 0;
}

References d, KisKHelpMenuPrivate::mAboutAppAction, KisKHelpMenuPrivate::mAboutKDEAction, menuAboutApp, menuAboutKDE, menuHelpContents, menuReportBug, menuSwitchLanguage, menuWhatsThis, KisKHelpMenuPrivate::mHandBookAction, KisKHelpMenuPrivate::mReportBugAction, KisKHelpMenuPrivate::mSwitchApplicationLanguageAction, and KisKHelpMenuPrivate::mWhatsThisAction.

◆ appHelpActivated

void KisKHelpMenu::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 211 of file khelpmenu.cpp.

{
    QDesktopServices::openUrl(QUrl(QStringLiteral("help:/")));
}

◆ contextHelpActivated

void KisKHelpMenu::contextHelpActivated ( )

slot

Activates What's This help for the application.

Definition at line 281 of file khelpmenu.cpp.

{
    QWhatsThis::enterWhatsThisMode();
}

◆ dialogFinished

void KisKHelpMenu::dialogFinished ( )

privateslot

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

Definition at line 254 of file khelpmenu.cpp.

{
    QTimer::singleShot(0, this, SLOT(timerExpired()));
}

References timerExpired().

◆ menu()

QMenu * KisKHelpMenu::menu ( )

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

The returned menu is configured with an icon, a title and menu entries. Therefore adding the returned pointer to your menu is enough to have access to the help menu.

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 127 of file khelpmenu.cpp.

{
    if (!d->mMenu) {
        d->mMenu = new QMenu();
        connect(d->mMenu, SIGNAL(destroyed()), this, SLOT(menuDestroyed()));
 
        d->mMenu->setTitle(i18n("&Help"));
 
        d->createActions(this);
 
        bool need_separator = false;
        if (d->mHandBookAction) {
            d->mMenu->addAction(d->mHandBookAction);
            need_separator = true;
        }
 
        if (d->mWhatsThisAction) {
            d->mMenu->addAction(d->mWhatsThisAction);
            need_separator = true;
        }
 
        if (d->mReportBugAction) {
            if (need_separator) {
                d->mMenu->addSeparator();
            }
            d->mMenu->addAction(d->mReportBugAction);
            need_separator = true;
        }
 
        if (d->mSwitchApplicationLanguageAction) {
            if (need_separator) {
                d->mMenu->addSeparator();
            }
            d->mMenu->addAction(d->mSwitchApplicationLanguageAction);
            need_separator = true;
        }
 
        if (need_separator) {
            d->mMenu->addSeparator();
        }
 
        if (d->mAboutAppAction) {
            d->mMenu->addAction(d->mAboutAppAction);
        }
 
        if (d->mAboutKDEAction) {
            d->mMenu->addAction(d->mAboutKDEAction);
        }
    }
 
    return d->mMenu;
}

References connect(), KisKHelpMenuPrivate::createActions(), d, KisKHelpMenuPrivate::mAboutAppAction, KisKHelpMenuPrivate::mAboutKDEAction, menuDestroyed(), KisKHelpMenuPrivate::mHandBookAction, KisKHelpMenuPrivate::mMenu, KisKHelpMenuPrivate::mReportBugAction, KisKHelpMenuPrivate::mSwitchApplicationLanguageAction, and KisKHelpMenuPrivate::mWhatsThisAction.

◆ menuDestroyed

void KisKHelpMenu::menuDestroyed ( )

privateslot

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 KisKHelpMenu destructor do the job.

Definition at line 276 of file khelpmenu.cpp.

{
    d->mMenu = 0;
}

References d, and KisKHelpMenuPrivate::mMenu.

◆ reportBug

void KisKHelpMenu::reportBug ( )

slot

Opens the standard "Report Bugs" dialog box.

Definition at line 232 of file khelpmenu.cpp.

{
#ifdef KRITA_STABLE
    QDesktopServices::openUrl(QUrl("https://docs.krita.org/en/untranslatable_pages/reporting_bugs.html"));
#else
    if (!d->mBugReport) {
        d->mBugReport = new KisKBugReport(d->mAboutData, d->mParent);
        connect(d->mBugReport, SIGNAL(finished(int)), this, SLOT(dialogFinished()));
    }
    d->mBugReport->show();
#endif
}

References connect(), d, dialogFinished(), KisKHelpMenuPrivate::mAboutData, KisKHelpMenuPrivate::mBugReport, and KisKHelpMenuPrivate::mParent.

◆ showAboutApplication

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

◆ switchApplicationLanguage

void KisKHelpMenu::switchApplicationLanguage ( )

slot

Opens the changing default application language dialog box.

Definition at line 245 of file khelpmenu.cpp.

{
    if (!d->mSwitchApplicationLanguage) {
        d->mSwitchApplicationLanguage = new KisKSwitchLanguageDialog(d->mParent);
        connect(d->mSwitchApplicationLanguage, SIGNAL(finished(int)), this, SLOT(dialogFinished()));
    }
    d->mSwitchApplicationLanguage->show();
}

References connect(), d, dialogFinished(), KisKHelpMenuPrivate::mParent, and KisKHelpMenuPrivate::mSwitchApplicationLanguage.

◆ timerExpired

void KisKHelpMenu::timerExpired ( )

privateslot

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

Definition at line 259 of file khelpmenu.cpp.

{
    if (d->mAboutKDE && !d->mAboutKDE->isVisible()) {
        delete d->mAboutKDE; d->mAboutKDE = 0;
    }
 
    if (d->mBugReport && !d->mBugReport->isVisible()) {
        delete d->mBugReport; d->mBugReport = 0;
    }
    if (d->mSwitchApplicationLanguage && !d->mSwitchApplicationLanguage->isVisible()) {
        delete d->mSwitchApplicationLanguage; d->mSwitchApplicationLanguage = 0;
    }
    if (d->mAboutApp && !d->mAboutApp->isVisible()) {
        delete d->mAboutApp; d->mAboutApp = 0;
    }
}

References d, KisKHelpMenuPrivate::mAboutApp, KisKHelpMenuPrivate::mAboutKDE, KisKHelpMenuPrivate::mBugReport, and KisKHelpMenuPrivate::mSwitchApplicationLanguage.

Member Data Documentation

◆ d

KisKHelpMenuPrivate* const KisKHelpMenu::d

private

Definition at line 248 of file khelpmenu.h.

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

libs/widgetutils/xmlgui/khelpmenu.h
libs/widgetutils/xmlgui/khelpmenu.cpp

Public Types

Public Slots

Signals

Public Member Functions

Private Slots

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ MenuId

Constructor & Destructor Documentation

◆ KisKHelpMenu() [1/2]

◆ KisKHelpMenu() [2/2]

◆ ~KisKHelpMenu()

Member Function Documentation

◆ aboutApplication

◆ aboutKDE

◆ action()

◆ appHelpActivated

◆ contextHelpActivated

◆ dialogFinished

◆ menu()

◆ menuDestroyed

◆ reportBug

◆ showAboutApplication

◆ switchApplicationLanguage

◆ timerExpired

Member Data Documentation

◆ d