/usr/include/KF5/KXmlGui/khelpmenu.h is in libkf5xmlgui-dev 5.28.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | /*
* This file is part of the KDE Libraries
* Copyright (C) 1999-2000 Espen Sand (espen@kde.org)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef KHELPMENU_H
#define KHELPMENU_H
#include <kxmlgui_export.h>
#include <QtCore/QObject>
#include <QtCore/QString>
class QMenu;
class QWidget;
class QAction;
class KAboutData;
class KHelpMenuPrivate;
/**
* @short 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:
*
* \code
* mHelpMenu = new KHelpMenu( this, <someText> );
* kmenubar->addMenu(mHelpMenu->menu() );
* \endcode
*
* or if you just want to open a dialog box:
*
* \code
* mHelpMenu = new KHelpMenu( this, <someText> );
* connect( this, SIGNAL(someSignal()), mHelpMenu,SLOT(aboutKDE()));
* \endcode
*
* IMPORTANT:
* The first time you use KHelpMenu::menu(), a QMenu 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.
*
* \code
* MyClass::~MyClass()
* {
* delete mHelpMenu;
* }
* \endcode
*
*
* 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.
*
* \code
* void MyClass::myFunc()
* {
* ..
* KHelpMenu *helpMenu = new KHelpMenu( this );
* connect( helpMenu, SIGNAL(showAboutApplication()),
* this, SLOT(myDialogSlot()));
* ..
* }
*
* void MyClass::myDialogSlot()
* {
* <activate your custom dialog>
* }
* \endcode
*
* \image html khelpmenu.png "KDE Help Menu"
*
* KHelpMenu respects Kiosk settings (see the KAuthorized namespace in the
* KConfig framework). In particular, system administrators can disable items
* on this menu using some subset of the following configuration:
* @verbatim
[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
@endverbatim
*
* @author Espen Sand (espen@kde.org)
*/
class KXMLGUI_EXPORT KHelpMenu : public QObject
{
Q_OBJECT
public:
/**
* Constructor.
*
* @param parent The parent of the dialog boxes. The boxes are modeless
* and will be centered with respect to the parent.
* @param aboutAppText User definable string that is used in the
* default application dialog box.
* @param showWhatsThis Decides whether a "Whats this" entry will be
* added to the dialog.
*
*/
explicit KHelpMenu(QWidget *parent = 0, const QString &aboutAppText = QString(),
bool showWhatsThis = true);
/**
* Constructor.
*
* This alternative constructor is mainly useful if you want to
* overide the standard actions (aboutApplication(), aboutKDE(),
* helpContents(), reportBug, and optionally whatsThis).
*
* @param parent The parent of the dialog boxes. The boxes are modeless
* and will be centered with respect to the parent.
* @param aboutData User and app data used in the About app dialog
* @param showWhatsThis Decides whether a "Whats this" entry will be
* added to the dialog.
*/
KHelpMenu(QWidget *parent, const KAboutData &aboutData,
bool showWhatsThis = true);
/**
* Destructor
*
* Destroys dialogs and the menu pointer retuned by menu
*/
~KHelpMenu();
/**
* 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 enougth 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.
*/
QMenu *menu();
enum MenuId {
menuHelpContents = 0,
menuWhatsThis = 1,
menuAboutApp = 2,
menuAboutKDE = 3,
menuReportBug = 4,
menuSwitchLanguage = 5,
menuDonate = 6 //< @since 5.24
};
/**
* Returns the QAction * associated with the given parameter
* Will return NULL pointers if menu() has not been called
*
* @param id The id of the action of which you want to get QAction *
*/
QAction *action(MenuId id) const;
public Q_SLOTS:
/**
* 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 appHelpActivated();
/**
* Activates What's This help for the application.
*/
void contextHelpActivated();
/**
* 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.
*/
void aboutApplication();
/**
* Opens the standard "About KDE" dialog box.
*/
void aboutKDE();
/**
* Opens the standard "Report Bugs" dialog box.
*/
void reportBug();
/**
* Opens the changing default application language dialog box.
*/
void switchApplicationLanguage();
/**
* Opens the donate url.
* @since 5.24
*/
void donate();
private Q_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();
/**
* Connected to the dialogs (about kde and bug report) to detect
* when they are finished.
*/
void dialogFinished();
/**
* 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
*/
void timerExpired();
Q_SIGNALS:
/**
* 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 showAboutApplication();
private:
KHelpMenuPrivate *const d;
};
#endif
|