digiKam
Digikam::DXmlGuiWindow Class Referenceabstract
+ Inheritance diagram for Digikam::DXmlGuiWindow:

Classes

class  Private
 

Public Member Functions

QList< QAction * > allActions () const
 
void cleanupActions ()
 
QString configGroupName () const
 
void createFullScreenAction (const QString &name)
 
void createHelpActions (bool coreOptions=true)
 
void createSettingsActions ()
 
void createSidebarActions ()
 
 DXmlGuiWindow (QWidget *const parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 
bool fullScreenIsActive () const
 
virtual DInfoInterfaceinfoIface (DPluginAction *const ac)=0
 
void readFullScreenSettings (const KConfigGroup &group)
 
virtual void registerExtraPluginsActions (QString &)
 
void registerPluginsActions ()
 
void setConfigGroupName (const QString &name)
 
void setFullScreenOptions (int options)
 
 ~DXmlGuiWindow () override
 

Static Public Member Functions

static QAction * buildStdAction (StdActionType type, const QObject *const recvr, const char *const slot, QObject *const parent)
 
static void openHandbook ()
 
static void restoreWindowSize (QWindow *const win, const KConfigGroup &group)
 
static void saveWindowSize (QWindow *const win, KConfigGroup &group)
 
static void setupIconTheme ()
 

Protected Slots

bool slotClose ()
 

Protected Member Functions

void closeEvent (QCloseEvent *e) override
 
virtual void customizedFullScreenMode (bool set)
 
void editKeyboardShortcuts (KActionCollection *const extraac=nullptr, const QString &actitle=QString())
 
bool eventFilter (QObject *obj, QEvent *ev) override
 
void keyPressEvent (QKeyEvent *e) override
 
QAction * showMenuBarAction () const
 
virtual void showSideBars (bool visible)
 
QAction * showStatusBarAction () const
 
virtual void showThumbBar (bool visible)
 
virtual bool thumbbarVisibility () const
 

Protected Attributes

DLogoActionm_animLogo
 

Detailed Description

Data container to use in managed window.

Constructor & Destructor Documentation

◆ DXmlGuiWindow()

Digikam::DXmlGuiWindow::DXmlGuiWindow ( QWidget *const  parent = nullptr,
Qt::WindowFlags  f = Qt::WindowFlags() 
)
explicit

References m_animLogo.

◆ ~DXmlGuiWindow()

Digikam::DXmlGuiWindow::~DXmlGuiWindow ( )
override

Member Function Documentation

◆ allActions()

QList< QAction * > Digikam::DXmlGuiWindow::allActions ( ) const

Return all actions from internal collection.

◆ buildStdAction()

◆ cleanupActions()

void Digikam::DXmlGuiWindow::cleanupActions ( )

Cleanup unwanted actions from action collection.

Referenced by ShowFoto::Showfoto::Showfoto().

◆ closeEvent()

void Digikam::DXmlGuiWindow::closeEvent ( QCloseEvent *  e)
overrideprotected

◆ configGroupName()

◆ createFullScreenAction()

void Digikam::DXmlGuiWindow::createFullScreenAction ( const QString &  name)

Create Full-screen action to action collection instance from managed window set through setManagedWindow(). This action is connected to slotToggleFullScreen() slot. 'name' is action name used in KDE UI rc file.

References Digikam::DXmlGuiWindow::Private::fullScreenAction, and Digikam::DXmlGuiWindow::Private::fullScreenBtn.

Referenced by Digikam::EditorWindow::setupStandardActions().

◆ createHelpActions()

void Digikam::DXmlGuiWindow::createHelpActions ( bool  coreOptions = true)

◆ createSettingsActions()

void Digikam::DXmlGuiWindow::createSettingsActions ( )

◆ createSidebarActions()

void Digikam::DXmlGuiWindow::createSidebarActions ( )

Create common actions to handle side-bar through keyboard shortcuts.

Referenced by Digikam::EditorWindow::setupStandardActions().

◆ customizedFullScreenMode()

void Digikam::DXmlGuiWindow::customizedFullScreenMode ( bool  set)
protectedvirtual

Re-implement this method if you want to manage customized view visibility in full-screen mode. This method is called by switchWindowToFullScreen(). By default this method do nothing.

◆ editKeyboardShortcuts()

void Digikam::DXmlGuiWindow::editKeyboardShortcuts ( KActionCollection *const  extraac = nullptr,
const QString &  actitle = QString() 
)
protected

Call this method from your main window to show keyboard shortcut config dialog with an extra action collection to configure. This method is called by slotEditKeys() which can be re-implement in child class for cutomization.

◆ eventFilter()

bool Digikam::DXmlGuiWindow::eventFilter ( QObject *  obj,
QEvent *  ev 
)
overrideprotected

◆ fullScreenIsActive()

bool Digikam::DXmlGuiWindow::fullScreenIsActive ( ) const

Return true if managed window is currently in Full Screen Mode.

References Digikam::DXmlGuiWindow::Private::fullScreenAction.

Referenced by eventFilter(), and keyPressEvent().

◆ infoIface()

virtual DInfoInterface* Digikam::DXmlGuiWindow::infoIface ( DPluginAction *const  ac)
pure virtual

◆ keyPressEvent()

void Digikam::DXmlGuiWindow::keyPressEvent ( QKeyEvent *  e)
overrideprotected

◆ openHandbook()

void Digikam::DXmlGuiWindow::openHandbook ( )
static

◆ readFullScreenSettings()

◆ registerExtraPluginsActions()

virtual void Digikam::DXmlGuiWindow::registerExtraPluginsActions ( QString &  )
inlinevirtual

Reimplemented in Digikam::EditorWindow.

Referenced by registerPluginsActions().

◆ registerPluginsActions()

◆ restoreWindowSize()

void Digikam::DXmlGuiWindow::restoreWindowSize ( QWindow *const  win,
const KConfigGroup &  group 
)
static

◆ saveWindowSize()

void Digikam::DXmlGuiWindow::saveWindowSize ( QWindow *const  win,
KConfigGroup &  group 
)
static

◆ setConfigGroupName()

void Digikam::DXmlGuiWindow::setConfigGroupName ( const QString &  name)

Manage config group name used by window instance to get/set settings from config file

References Digikam::DXmlGuiWindow::Private::configGroupName.

Referenced by Digikam::DigikamApp::DigikamApp(), Digikam::EditorWindow::EditorWindow(), and Digikam::ImportUI::ImportUI().

◆ setFullScreenOptions()

void Digikam::DXmlGuiWindow::setFullScreenOptions ( int  options)

◆ setupIconTheme()

void Digikam::DXmlGuiWindow::setupIconTheme ( )
static

If we have some local breeze icon resource, prefer it.

◆ showMenuBarAction()

QAction * Digikam::DXmlGuiWindow::showMenuBarAction ( ) const
protected

◆ showSideBars()

void Digikam::DXmlGuiWindow::showSideBars ( bool  visible)
protectedvirtual

Re-implement this method if you want to manage sidebars visibility in full-screen mode. By default this method do nothing.

◆ showStatusBarAction()

QAction * Digikam::DXmlGuiWindow::showStatusBarAction ( ) const
protected

◆ showThumbBar()

void Digikam::DXmlGuiWindow::showThumbBar ( bool  visible)
protectedvirtual

Re-implement this method if you want to manage thumbbar visibility in full-screen mode. By default this method do nothing.

◆ slotClose

bool Digikam::DXmlGuiWindow::slotClose ( )
protectedslot

◆ thumbbarVisibility()

bool Digikam::DXmlGuiWindow::thumbbarVisibility ( ) const
protectedvirtual

Re-implement this method if managed window has a thumbbar. This must return visibility state of it.

Member Data Documentation

◆ m_animLogo


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