KXmlGuiWindow
#include <KXmlGuiWindow>

Public Types | |
enum | StandardWindowOption { ToolBar = 1, Keys = 2, StatusBar = 4, Save = 8, Create = 16, Default = ToolBar | Keys | StatusBar | Save | Create } |
typedef QFlags< StandardWindowOption > | StandardWindowOptions |
![]() | |
enum | DockOption |
![]() | |
enum | RenderFlag |
![]() | |
enum | PaintDeviceMetric |
![]() | |
enum | ReverseStateChange { StateNoReverse, StateReverse } |
Public Slots | |
virtual void | configureToolbars () |
virtual void | slotStateChanged (const QString &newstate) |
void | slotStateChanged (const QString &newstate, bool reverse) |
![]() | |
void | appHelpActivated () |
virtual void | setCaption (const QString &caption) |
virtual void | setCaption (const QString &caption, bool modified) |
virtual void | setPlainCaption (const QString &caption) |
void | setSettingsDirty () |
Public Member Functions | |
KXmlGuiWindow (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags()) | |
~KXmlGuiWindow () override | |
void | applyMainWindowSettings (const KConfigGroup &config) override |
void | createGUI (const QString &xmlfile=QString()) |
void | createStandardStatusBarAction () |
void | finalizeGUI (bool force) |
void | finalizeGUI (KXMLGUIClient *client) override |
virtual KXMLGUIFactory * | guiFactory () |
bool | isCommandBarEnabled () const |
bool | isHelpMenuEnabled () const |
bool | isStandardToolBarMenuEnabled () const |
void | setCommandBarEnabled (bool enable) |
void | setHelpMenuEnabled (bool showHelpMenu=true) |
void | setStandardToolBarMenuEnabled (bool enable) |
void | setupGUI (const QSize &defaultSize, StandardWindowOptions options=Default, const QString &xmlfile=QString()) |
void | setupGUI (StandardWindowOptions options=Default, const QString &xmlfile=QString()) |
void | setupToolbarMenuActions () |
QAction * | toolBarMenuAction () |
![]() | |
KMainWindow (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags()) | |
~KMainWindow () override | |
KConfigGroup | autoSaveConfigGroup () const |
QString | autoSaveGroup () const |
bool | autoSaveSettings () const |
QMenu * | customHelpMenu (bool showWhatsThis=true) |
QString | dbusName () const |
bool | hasMenuBar () |
QMenu * | helpMenu (const QString &aboutAppText=QString(), bool showWhatsThis=true) |
bool | initialGeometrySet () const |
void | resetAutoSaveSettings () |
bool | restore (int number, bool show=true) |
void | saveMainWindowSettings (KConfigGroup &config) |
void | setAutoSaveSettings (const KConfigGroup &group, bool saveWindowSize=true) |
void | setAutoSaveSettings (const QString &groupName=QStringLiteral("MainWindow"), bool saveWindowSize=true) |
void | setStateConfigGroup (const QString &configGroup) |
KConfigGroup | stateConfigGroup () const |
KToolBar * | toolBar (const QString &name=QString()) |
QList< KToolBar * > | toolBars () const |
![]() | |
QMainWindow (QWidget *parent, Qt::WindowFlags flags) | |
void | addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget) |
void | addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget, Qt::Orientation orientation) |
QToolBar * | addToolBar (const QString &title) |
void | addToolBar (Qt::ToolBarArea area, QToolBar *toolbar) |
void | addToolBar (QToolBar *toolbar) |
void | addToolBarBreak (Qt::ToolBarArea area) |
QWidget * | centralWidget () const const |
Qt::DockWidgetArea | corner (Qt::Corner corner) const const |
virtual QMenu * | createPopupMenu () |
QMainWindow::DockOptions | dockOptions () const const |
Qt::DockWidgetArea | dockWidgetArea (QDockWidget *dockwidget) const const |
bool | documentMode () const const |
QSize | iconSize () const const |
void | iconSizeChanged (const QSize &iconSize) |
void | insertToolBar (QToolBar *before, QToolBar *toolbar) |
void | insertToolBarBreak (QToolBar *before) |
bool | isAnimated () const const |
bool | isDockNestingEnabled () const const |
QMenuBar * | menuBar () const const |
QWidget * | menuWidget () const const |
void | removeDockWidget (QDockWidget *dockwidget) |
void | removeToolBar (QToolBar *toolbar) |
void | removeToolBarBreak (QToolBar *before) |
void | resizeDocks (const QList< QDockWidget * > &docks, const QList< int > &sizes, Qt::Orientation orientation) |
bool | restoreDockWidget (QDockWidget *dockwidget) |
bool | restoreState (const QByteArray &state, int version) |
QByteArray | saveState (int version) const const |
void | setAnimated (bool enabled) |
void | setCentralWidget (QWidget *widget) |
void | setCorner (Qt::Corner corner, Qt::DockWidgetArea area) |
void | setDockNestingEnabled (bool enabled) |
void | setDockOptions (QMainWindow::DockOptions options) |
void | setDocumentMode (bool enabled) |
void | setIconSize (const QSize &iconSize) |
void | setMenuBar (QMenuBar *menuBar) |
void | setMenuWidget (QWidget *menuBar) |
void | setStatusBar (QStatusBar *statusbar) |
void | setTabPosition (Qt::DockWidgetAreas areas, QTabWidget::TabPosition tabPosition) |
void | setTabShape (QTabWidget::TabShape tabShape) |
void | setToolButtonStyle (Qt::ToolButtonStyle toolButtonStyle) |
void | setUnifiedTitleAndToolBarOnMac (bool set) |
void | splitDockWidget (QDockWidget *first, QDockWidget *second, Qt::Orientation orientation) |
QStatusBar * | statusBar () const const |
void | tabifiedDockWidgetActivated (QDockWidget *dockWidget) |
QList< QDockWidget * > | tabifiedDockWidgets (QDockWidget *dockwidget) const const |
void | tabifyDockWidget (QDockWidget *first, QDockWidget *second) |
QTabWidget::TabPosition | tabPosition (Qt::DockWidgetArea area) const const |
QTabWidget::TabShape | tabShape () const const |
QWidget * | takeCentralWidget () |
Qt::ToolBarArea | toolBarArea (QToolBar *toolbar) const const |
bool | toolBarBreak (QToolBar *toolbar) const const |
Qt::ToolButtonStyle | toolButtonStyle () const const |
void | toolButtonStyleChanged (Qt::ToolButtonStyle toolButtonStyle) |
bool | unifiedTitleAndToolBarOnMac () const const |
![]() | |
QWidget (QWidget *parent, Qt::WindowFlags f) | |
bool | acceptDrops () const const |
QString | accessibleDescription () const const |
QString | accessibleName () const const |
QList< QAction * > | actions () const const |
void | activateWindow () |
void | addAction (QAction *action) |
void | addActions (QList< QAction * > actions) |
void | adjustSize () |
bool | autoFillBackground () const const |
QPalette::ColorRole | backgroundRole () const const |
QBackingStore * | backingStore () const const |
QSize | baseSize () const const |
QWidget * | childAt (const QPoint &p) const const |
QWidget * | childAt (int x, int y) const const |
QRect | childrenRect () const const |
QRegion | childrenRegion () const const |
void | clearFocus () |
void | clearMask () |
bool | close () |
QMargins | contentsMargins () const const |
QRect | contentsRect () const const |
Qt::ContextMenuPolicy | contextMenuPolicy () const const |
QCursor | cursor () const const |
void | customContextMenuRequested (const QPoint &pos) |
WId | effectiveWinId () const const |
void | ensurePolished () const const |
Qt::FocusPolicy | focusPolicy () const const |
QWidget * | focusProxy () const const |
QWidget * | focusWidget () const const |
const QFont & | font () const const |
QFontInfo | fontInfo () const const |
QFontMetrics | fontMetrics () const const |
QPalette::ColorRole | foregroundRole () const const |
QRect | frameGeometry () const const |
QSize | frameSize () const const |
const QRect & | geometry () const const |
void | getContentsMargins (int *left, int *top, int *right, int *bottom) const const |
QPixmap | grab (const QRect &rectangle) |
void | grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags) |
void | grabKeyboard () |
void | grabMouse () |
void | grabMouse (const QCursor &cursor) |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context) |
QGraphicsEffect * | graphicsEffect () const const |
QGraphicsProxyWidget * | graphicsProxyWidget () const const |
bool | hasEditFocus () const const |
bool | hasFocus () const const |
virtual bool | hasHeightForWidth () const const |
bool | hasMouseTracking () const const |
bool | hasTabletTracking () const const |
int | height () const const |
virtual int | heightForWidth (int w) const const |
void | hide () |
Qt::InputMethodHints | inputMethodHints () const const |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const const |
void | insertAction (QAction *before, QAction *action) |
void | insertActions (QAction *before, QList< QAction * > actions) |
bool | isActiveWindow () const const |
bool | isAncestorOf (const QWidget *child) const const |
bool | isEnabled () const const |
bool | isEnabledTo (const QWidget *ancestor) const const |
bool | isEnabledToTLW () const const |
bool | isFullScreen () const const |
bool | isHidden () const const |
bool | isMaximized () const const |
bool | isMinimized () const const |
bool | isModal () const const |
bool | isTopLevel () const const |
bool | isVisible () const const |
bool | isVisibleTo (const QWidget *ancestor) const const |
bool | isWindow () const const |
bool | isWindowModified () const const |
QLayout * | layout () const const |
Qt::LayoutDirection | layoutDirection () const const |
QLocale | locale () const const |
void | lower () |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QRegion | mask () const const |
int | maximumHeight () const const |
QSize | maximumSize () const const |
int | maximumWidth () const const |
int | minimumHeight () const const |
QSize | minimumSize () const const |
virtual QSize | minimumSizeHint () const const |
int | minimumWidth () const const |
void | move (const QPoint &) |
void | move (int x, int y) |
QWidget * | nativeParentWidget () const const |
QWidget * | nextInFocusChain () const const |
QRect | normalGeometry () const const |
void | overrideWindowFlags (Qt::WindowFlags flags) |
virtual QPaintEngine * | paintEngine () const const override |
const QPalette & | palette () const const |
QWidget * | parentWidget () const const |
QPoint | pos () const const |
QWidget * | previousInFocusChain () const const |
QWIDGETSIZE_MAX QWIDGETSIZE_MAX | |
void | raise () |
QRect | rect () const const |
void | releaseKeyboard () |
void | releaseMouse () |
void | releaseShortcut (int id) |
void | removeAction (QAction *action) |
void | render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | repaint () |
void | repaint (const QRect &rect) |
void | repaint (const QRegion &rgn) |
void | repaint (int x, int y, int w, int h) |
void | resize (const QSize &) |
void | resize (int w, int h) |
bool | restoreGeometry (const QByteArray &geometry) |
QByteArray | saveGeometry () const const |
QScreen * | screen () const const |
void | scroll (int dx, int dy) |
void | scroll (int dx, int dy, const QRect &r) |
void | setAcceptDrops (bool on) |
void | setAccessibleDescription (const QString &description) |
void | setAccessibleName (const QString &name) |
void | setAttribute (Qt::WidgetAttribute attribute, bool on) |
void | setAutoFillBackground (bool enabled) |
void | setBackgroundRole (QPalette::ColorRole role) |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
void | setContentsMargins (const QMargins &margins) |
void | setContentsMargins (int left, int top, int right, int bottom) |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | setCursor (const QCursor &) |
void | setDisabled (bool disable) |
void | setEditFocus (bool enable) |
void | setEnabled (bool) |
void | setFixedHeight (int h) |
void | setFixedSize (const QSize &s) |
void | setFixedSize (int w, int h) |
void | setFixedWidth (int w) |
void | setFocus () |
void | setFocus (Qt::FocusReason reason) |
void | setFocusPolicy (Qt::FocusPolicy policy) |
void | setFocusProxy (QWidget *w) |
void | setFont (const QFont &) |
void | setForegroundRole (QPalette::ColorRole role) |
void | setGeometry (const QRect &) |
void | setGeometry (int x, int y, int w, int h) |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | setHidden (bool hidden) |
void | setInputMethodHints (Qt::InputMethodHints hints) |
void | setLayout (QLayout *layout) |
void | setLayoutDirection (Qt::LayoutDirection direction) |
void | setLocale (const QLocale &locale) |
void | setMask (const QBitmap &bitmap) |
void | setMask (const QRegion ®ion) |
void | setMaximumHeight (int maxh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
void | setMaximumWidth (int maxw) |
void | setMinimumHeight (int minh) |
void | setMinimumSize (const QSize &) |
void | setMinimumSize (int minw, int minh) |
void | setMinimumWidth (int minw) |
void | setMouseTracking (bool enable) |
void | setPalette (const QPalette &) |
void | setParent (QWidget *parent) |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
void | setShortcutAutoRepeat (int id, bool enable) |
void | setShortcutEnabled (int id, bool enable) |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
void | setSizePolicy (QSizePolicy) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
void | setStatusTip (const QString &) |
void | setStyle (QStyle *style) |
void | setStyleSheet (const QString &styleSheet) |
void | setTabletTracking (bool enable) |
void | setToolTip (const QString &) |
void | setToolTipDuration (int msec) |
void | setUpdatesEnabled (bool enable) |
void | setupUi (QWidget *widget) |
virtual void | setVisible (bool visible) |
void | setWhatsThis (const QString &) |
void | setWindowFilePath (const QString &filePath) |
void | setWindowFlag (Qt::WindowType flag, bool on) |
void | setWindowFlags (Qt::WindowFlags type) |
void | setWindowIcon (const QIcon &icon) |
void | setWindowIconText (const QString &) |
void | setWindowModality (Qt::WindowModality windowModality) |
void | setWindowModified (bool) |
void | setWindowOpacity (qreal level) |
void | setWindowRole (const QString &role) |
void | setWindowState (Qt::WindowStates windowState) |
void | setWindowTitle (const QString &) |
void | show () |
void | showFullScreen () |
void | showMaximized () |
void | showMinimized () |
void | showNormal () |
QSize | size () const const |
virtual QSize | sizeHint () const const |
QSize | sizeIncrement () const const |
QSizePolicy | sizePolicy () const const |
void | stackUnder (QWidget *w) |
QString | statusTip () const const |
QStyle * | style () const const |
QString | styleSheet () const const |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
QString | toolTip () const const |
int | toolTipDuration () const const |
QWidget * | topLevelWidget () const const |
bool | underMouse () const const |
void | ungrabGesture (Qt::GestureType gesture) |
void | unsetCursor () |
void | unsetLayoutDirection () |
void | unsetLocale () |
void | update () |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | update (int x, int y, int w, int h) |
void | updateGeometry () |
bool | updatesEnabled () const const |
QRegion | visibleRegion () const const |
QString | whatsThis () const const |
int | width () const const |
QWidget * | window () const const |
QString | windowFilePath () const const |
Qt::WindowFlags | windowFlags () const const |
QWindow * | windowHandle () const const |
QIcon | windowIcon () const const |
void | windowIconChanged (const QIcon &icon) |
QString | windowIconText () const const |
void | windowIconTextChanged (const QString &iconText) |
Qt::WindowModality | windowModality () const const |
qreal | windowOpacity () const const |
QString | windowRole () const const |
Qt::WindowStates | windowState () const const |
QString | windowTitle () const const |
void | windowTitleChanged (const QString &title) |
Qt::WindowType | windowType () const const |
WId | winId () const const |
int | x () const const |
int | y () const const |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
![]() | |
int | colorCount () const const |
int | depth () const const |
int | devicePixelRatio () const const |
qreal | devicePixelRatioF () const const |
int | height () const const |
int | heightMM () const const |
int | logicalDpiX () const const |
int | logicalDpiY () const const |
bool | paintingActive () const const |
int | physicalDpiX () const const |
int | physicalDpiY () const const |
int | width () const const |
int | widthMM () const const |
![]() | |
KXMLGUIBuilder (QWidget *widget) | |
KXMLGUIClient * | builderClient () const |
virtual QStringList | containerTags () const |
virtual QWidget * | createContainer (QWidget *parent, int index, const QDomElement &element, QAction *&containerAction) |
virtual QAction * | createCustomElement (QWidget *parent, int index, const QDomElement &element) |
virtual QStringList | customTags () const |
virtual void | removeContainer (QWidget *container, QWidget *parent, QDomElement &element, QAction *containerAction) |
virtual void | removeCustomElement (QWidget *parent, QAction *action) |
void | setBuilderClient (KXMLGUIClient *client) |
QWidget * | widget () |
![]() | |
KXMLGUIClient () | |
KXMLGUIClient (KXMLGUIClient *parent) | |
virtual | ~KXMLGUIClient () |
QAction * | action (const char *name) const |
virtual QAction * | action (const QDomElement &element) const |
virtual KActionCollection * | actionCollection () const |
void | addStateActionDisabled (const QString &state, const QString &action) |
void | addStateActionEnabled (const QString &state, const QString &action) |
void | beginXMLPlug (QWidget *) |
QList< KXMLGUIClient * > | childClients () |
KXMLGUIBuilder * | clientBuilder () const |
virtual QString | componentName () const |
virtual QDomDocument | domDocument () const |
void | endXMLPlug () |
KXMLGUIFactory * | factory () const |
StateChange | getActionsToChangeForState (const QString &state) |
void | insertChildClient (KXMLGUIClient *child) |
virtual QString | localXMLFile () const |
KXMLGUIClient * | parentClient () const |
void | plugActionList (const QString &name, const QList< QAction * > &actionList) |
void | prepareXMLUnplug (QWidget *) |
void | reloadXML () |
void | removeChildClient (KXMLGUIClient *child) |
void | replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false) |
void | setClientBuilder (KXMLGUIBuilder *builder) |
void | setFactory (KXMLGUIFactory *factory) |
void | setXMLGUIBuildDocument (const QDomDocument &doc) |
void | unplugActionList (const QString &name) |
virtual QString | xmlFile () const |
QDomDocument | xmlguiBuildDocument () const |
Protected Slots | |
virtual void | saveNewToolbarConfig () |
![]() | |
void | saveAutoSaveSettings () |
virtual void | showAboutApplication () |
Protected Member Functions | |
void | checkAmbiguousShortcuts () |
bool | event (QEvent *event) override |
![]() | |
KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f) | |
void | closeEvent (QCloseEvent *) override |
virtual bool | queryClose () |
virtual void | readGlobalProperties (KConfig *sessionConfig) |
virtual void | readProperties (const KConfigGroup &) |
bool | readPropertiesInternal (KConfig *, int) |
void | restoreWindowSize (const KConfigGroup &config) |
virtual void | saveGlobalProperties (KConfig *sessionConfig) |
virtual void | saveProperties (KConfigGroup &) |
void | savePropertiesInternal (KConfig *, int) |
void | saveWindowSize (KConfigGroup &config) const |
bool | settingsDirty () const |
![]() | |
virtual void | contextMenuEvent (QContextMenuEvent *event) override |
![]() | |
virtual void | actionEvent (QActionEvent *event) |
virtual void | changeEvent (QEvent *event) |
void | create (WId window, bool initializeWindow, bool destroyOldWindow) |
void | destroy (bool destroyWindow, bool destroySubWindows) |
virtual void | dragEnterEvent (QDragEnterEvent *event) |
virtual void | dragLeaveEvent (QDragLeaveEvent *event) |
virtual void | dragMoveEvent (QDragMoveEvent *event) |
virtual void | dropEvent (QDropEvent *event) |
virtual void | enterEvent (QEvent *event) |
virtual void | focusInEvent (QFocusEvent *event) |
bool | focusNextChild () |
virtual bool | focusNextPrevChild (bool next) |
virtual void | focusOutEvent (QFocusEvent *event) |
bool | focusPreviousChild () |
virtual void | hideEvent (QHideEvent *event) |
virtual void | initPainter (QPainter *painter) const const override |
virtual void | inputMethodEvent (QInputMethodEvent *event) |
virtual void | keyPressEvent (QKeyEvent *event) |
virtual void | keyReleaseEvent (QKeyEvent *event) |
virtual void | leaveEvent (QEvent *event) |
virtual int | metric (QPaintDevice::PaintDeviceMetric m) const const override |
virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
virtual void | mouseMoveEvent (QMouseEvent *event) |
virtual void | mousePressEvent (QMouseEvent *event) |
virtual void | mouseReleaseEvent (QMouseEvent *event) |
virtual void | moveEvent (QMoveEvent *event) |
virtual bool | nativeEvent (const QByteArray &eventType, void *message, long *result) |
virtual void | paintEvent (QPaintEvent *event) |
virtual void | resizeEvent (QResizeEvent *event) |
virtual void | showEvent (QShowEvent *event) |
virtual void | tabletEvent (QTabletEvent *event) |
void | updateMicroFocus () |
virtual void | wheelEvent (QWheelEvent *event) |
![]() | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
![]() | |
virtual void | virtual_hook (int id, void *data) |
![]() | |
void | loadStandardsXmlFile () |
virtual void | setComponentName (const QString &componentName, const QString &componentDisplayName) |
virtual void | setDOMDocument (const QDomDocument &document, bool merge=false) |
virtual void | setLocalXMLFile (const QString &file) |
virtual void | setXML (const QString &document, bool merge=false) |
virtual void | setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true) |
virtual void | stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse) |
virtual void | virtual_hook (int id, void *data) |
Additional Inherited Members | |
![]() | |
static bool | canBeRestored (int number) |
static const QString | classNameOfToplevel (int number) |
static QList< KMainWindow * > | memberList () |
![]() | |
QWidget * | createWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags) |
QWidget * | find (WId id) |
QWidget * | keyboardGrabber () |
QWidget * | mouseGrabber () |
void | setTabOrder (QWidget *first, QWidget *second) |
![]() | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
static QString | findMostRecentXMLFile (const QStringList &files, QString &doc) |
static QString | findVersionNumber (const QString &xml) |
![]() | |
AllowNestedDocks | |
AllowTabbedDocks | |
AnimatedDocks | |
typedef | DockOptions |
ForceTabbedDocks | |
GroupedDragging | |
VerticalTabs | |
![]() | |
DrawChildren | |
DrawWindowBackground | |
IgnoreMask | |
typedef | RenderFlags |
![]() | |
typedef | QObjectList |
![]() | |
PdmDepth | |
PdmDevicePixelRatio | |
PdmDevicePixelRatioScaled | |
PdmDpiX | |
PdmDpiY | |
PdmHeight | |
PdmHeightMM | |
PdmNumColors | |
PdmPhysicalDpiX | |
PdmPhysicalDpiY | |
PdmWidth | |
PdmWidthMM | |
![]() | |
static QString | standardsXmlFileLocation () |
![]() | |
const std::unique_ptr< KMainWindowPrivate > | k_ptr |
![]() | |
#define | KDE_DEFAULT_WINDOWFLAGS 0 |
Detailed Description
Top level main window with predefined action layout.
Instead of creating a KMainWindow manually and assigning menus, menu entries, toolbar buttons and actions to it by hand, this class can be used to load an rc file to manage the main window's actions.
See https://techbase.kde.org/Development/Tutorials/Using_KActions#XMLGUI for essential information on the XML file format and usage of this class.
- See also
- KMainWindow
Definition at line 46 of file kxmlguiwindow.h.
Member Typedef Documentation
◆ StandardWindowOptions
Stores a combination of StandardWindowOption values.
Definition at line 246 of file kxmlguiwindow.h.
Member Enumeration Documentation
◆ StandardWindowOption
- See also
- setupGUI()
- StandardWindowOptions
Enumerator | |
---|---|
ToolBar | Adds action(s) to show/hide the toolbar(s) and adds a menu action to configure the toolbar(s).
|
Keys | Adds an action to open the configure keyboard shortcuts dialog. |
StatusBar | Adds action to show/hide the statusbar. Note that setting this value will create a statusbar if one doesn't already exist.
|
Save | Auto-saves (and loads) the toolbar/menubar/statusbar settings and window size using the default name. Typically you want to let the default window size be determined by the widgets size hints. Make sure that setupGUI() is called after all the widgets are created (including setCentralWidget) so that the default size will be correct.
|
Create | calls createGUI() once ToolBar, Keys and Statusbar have been taken care of.
|
Default | All the above option (this is the default) |
Definition at line 185 of file kxmlguiwindow.h.
Constructor & Destructor Documentation
◆ KXmlGuiWindow()
|
explicit |
Construct a main window.
- Parameters
-
parent The widget parent. This is usually 0 but it may also be the window group leader. In that case, the KXmlGuiWindow becomes sort of a secondary window. f Specify the window flags. The default is none.
Note that a KXmlGuiWindow per-default is created with the Qt::WA_DeleteOnClose attribute set, i.e. it is automatically destroyed when the window is closed. If you do not want this behavior, call
KXmlGuiWindows must be created on the heap with 'new', like:
IMPORTANT: For session management and window management to work properly, all main windows in the application should have a different name. If you don't do it, the base class KMainWindow will create a unique name, but it's recommended to explicitly pass a window name that will also describe the type of the window. If there can be several windows of the same type, append '#' (hash) to the name, and KMainWindow will replace it with numbers to make the names unique. For example, for a mail client which has one main window showing the mails and folders, and which can also have one or more windows for composing mails, the name for the folders window should be e.g. "mainwindow" and for the composer windows "composer#".
Set up KCommandBar launcher action
Do nothing when command bar is disabled
Definition at line 147 of file kxmlguiwindow.cpp.
◆ ~KXmlGuiWindow()
|
override |
Destructor.
Will also destroy the toolbars, and menubar if needed.
Definition at line 212 of file kxmlguiwindow.cpp.
Member Function Documentation
◆ applyMainWindowSettings()
|
overridevirtual |
Read settings for statusbar, menubar and toolbar from their respective groups in the config file and apply them.
- Parameters
-
config Config group to read the settings from.
KF5 porting note: the unused bool argument was removed, make sure to remove it from your reimplementations too! And add a override for good measure.
Reimplemented from KMainWindow.
Definition at line 480 of file kxmlguiwindow.cpp.
◆ checkAmbiguousShortcuts()
|
protected |
Checks if there are actions using the same shortcut.
This is called automatically from createGUI.
- Since
- 5.30
Definition at line 497 of file kxmlguiwindow.cpp.
◆ configureToolbars
|
virtualslot |
Show a standard configure toolbar dialog.
This slot can be connected directly to the action to configure toolbar. This is very simple to do that by adding a single line
Definition at line 260 of file kxmlguiwindow.cpp.
◆ createGUI()
Creates a GUI based on a local XML file.
Typically, i.e. in a regular application, you should use setupGUI() instead, since it runs some extra code, like setting up the toolbar/shortcut edit actions ...etc.
If xmlfile
is an empty string, this method will try to construct a local XML filename like appnameui.rc where 'appname' is your app's name. Typically that app name is what KXMLGUIClient::componentName() returns. If that file does not exist, then the XML UI code will only use the global (standard) XML file for the layout purposes.
- Parameters
-
xmlfile the path (relative or absolute) to the local xmlfile
Definition at line 327 of file kxmlguiwindow.cpp.
◆ createStandardStatusBarAction()
void KXmlGuiWindow::createStandardStatusBarAction | ( | ) |
Sets whether KMainWindow should provide a menu that allows showing/hiding of the statusbar (using KStandardAction::showStatusbar()).
Note that calling this method will create a statusbar if one doesn't already exist.
The menu / menu item is implemented using xmlgui. It will be inserted in your menu structure in the 'Settings' menu.
- Note
- You should enable this feature before calling createGUI() (or similar).
If an application maintains the action on its own (i.e. never calls this function) a connection needs to be made to let KMainWindow know when that status (hidden/shown) of the statusbar has changed. For example:
Otherwise the status (hidden/show) of the statusbar might not be saved by KMainWindow.
Definition at line 452 of file kxmlguiwindow.cpp.
◆ event()
|
overrideprotectedvirtual |
Reimplemented to catch QEvent::Polish in order to adjust the object name if needed, once all constructor code for the main window has run.
Also reimplemented to catch when a QDockWidget is added or removed.
Reimplemented from KMainWindow.
Definition at line 218 of file kxmlguiwindow.cpp.
◆ finalizeGUI()
void KXmlGuiWindow::finalizeGUI | ( | bool | force | ) |
Definition at line 469 of file kxmlguiwindow.cpp.
◆ isCommandBarEnabled()
bool KXmlGuiWindow::isCommandBarEnabled | ( | ) | const |
- Since
- 5.83
Definition at line 568 of file kxmlguiwindow.cpp.
◆ isHelpMenuEnabled()
bool KXmlGuiWindow::isHelpMenuEnabled | ( | ) | const |
Returns true
if the help menu is enabled, false
otherwise.
Definition at line 242 of file kxmlguiwindow.cpp.
◆ isStandardToolBarMenuEnabled()
bool KXmlGuiWindow::isStandardToolBarMenuEnabled | ( | ) | const |
Returns true
if the toolbar menu is enabled, false
otherwise.
Definition at line 446 of file kxmlguiwindow.cpp.
◆ saveNewToolbarConfig
|
protectedvirtualslot |
Rebuilds the GUI after KEditToolBar changed the toolbar layout.
- See also
- configureToolbars()
Definition at line 273 of file kxmlguiwindow.cpp.
◆ setCommandBarEnabled()
void KXmlGuiWindow::setCommandBarEnabled | ( | bool | enable | ) |
Enable a hud style menu which allows listing and executing actions.
The menu is launchable with the shortcut Alt+Ctrl+I
- Since
- 5.83
Unset the shortcut
Definition at line 552 of file kxmlguiwindow.cpp.
◆ setHelpMenuEnabled()
void KXmlGuiWindow::setHelpMenuEnabled | ( | bool | showHelpMenu = true | ) |
Enables the build of a standard help menu when calling createGUI() or setupGUI().
The default behavior is to create a help menu, you must call this function with false
to disable that.
Definition at line 236 of file kxmlguiwindow.cpp.
◆ setStandardToolBarMenuEnabled()
void KXmlGuiWindow::setStandardToolBarMenuEnabled | ( | bool | enable | ) |
Sets whether KMainWindow should provide a menu that allows showing/hiding the available toolbars (using KToggleToolBarAction).
If there is only one toolbar configured, a simple 'Show <toolbar name>' menu item is shown; if more than one toolbar are configured, a "Shown Toolbars" menu is created instead, with 'Show <toolbar1 name>', 'Show <toolbar2 name>' ...etc sub-menu actions.
The menu / menu item is implemented using xmlgui. It will be inserted in your menu structure in the 'Settings' menu.
If your application uses a non-standard xmlgui resource file then you can specify the exact position of the menu / menu item by adding a <Merge name="StandardToolBarMenuHandler" /> line to the settings menu section of your resource file ( usually appname.rc ).
- Note
- You should enable this feature before calling createGUI() ( or similar ).
Definition at line 419 of file kxmlguiwindow.cpp.
◆ setupGUI() [1/2]
void KXmlGuiWindow::setupGUI | ( | const QSize & | defaultSize, |
StandardWindowOptions | options = Default , |
||
const QString & | xmlfile = QString() |
||
) |
This is an overloaded method.
You can use defaultSize
to override the saved window size (e.g. the window size is saved to the config file if the StandardWindowOption::Save flag was set previously).
Definition at line 289 of file kxmlguiwindow.cpp.
◆ setupGUI() [2/2]
void KXmlGuiWindow::setupGUI | ( | StandardWindowOptions | options = Default , |
const QString & | xmlfile = QString() |
||
) |
Configures the current window and its actions in the typical KDE fashion.
You can specify which window options/features are going to be set up using options
,
- See also
- the StandardWindowOption enum for more details.
Typically this function replaces createGUI().
- Warning
- If you are calling createGUI() yourself, remember to remove the StandardWindowOption::Create flag from
options
.
- See also
- StandardWindowOptions
- Note
- Since this method will restore the state of the application window (toolbar, dockwindows positions ...etc), you need to have added all your actions to your toolbars ...etc before calling this method. (This note is only applicable if you are using the
StandardWindowOption::Default
orStandardWindowOption::Save
flags).
- Parameters
-
options an OR'ed combination of StandardWindowOption to specify which options are going to be set up for your application window, the default is StandardWindowOption::Default xmlfile the path (relative or absolute) to the local xmlfile, if this is an empty string the code will look for a local XML file appnameui.rc, where 'appname' is the name of your app, see the note about the xmlfile argument in the createGUI() docs.
Definition at line 284 of file kxmlguiwindow.cpp.
◆ setupToolbarMenuActions()
void KXmlGuiWindow::setupToolbarMenuActions | ( | ) |
for KToolBar
Definition at line 204 of file kxmlguiwindow.cpp.
◆ slotStateChanged [1/2]
|
virtualslot |
Apply a state change.
Enable and disable actions as defined in the XML rc file
Definition at line 409 of file kxmlguiwindow.cpp.
◆ slotStateChanged [2/2]
|
slot |
Apply a state change.
Enable and disable actions as defined in the XML rc file, can "reverse" the state (disable the actions which should be enabled, and vice-versa) if specified.
Definition at line 414 of file kxmlguiwindow.cpp.
◆ toolBarMenuAction()
QAction * KXmlGuiWindow::toolBarMenuAction | ( | ) |
Returns a pointer to the mainwindows action responsible for the toolbars menu.
Definition at line 194 of file kxmlguiwindow.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Jul 1 2022 05:15:27 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.