digiKam Developer Documentation
Professional Photo Management with the Power of Open Source
Loading...
Searching...
No Matches
Digikam::EditorWindow Class Referenceabstract
+ Inheritance diagram for Digikam::EditorWindow:

Public Types

enum  TransformType { RotateLeft , RotateRight , FlipHorizontal , FlipVertical }
 

Public Slots

void slotSetup () override=0
 
virtual void slotSetupICC ()=0
 

Signals

void signalNoCurrentItem ()
 
void signalPreviewModeChanged (int)
 
void signalSelectionChanged (const QRect &)
 
void signalToolApplied ()
 

Public Member Functions

 EditorWindow (const QString &name, QWidget *const parent=nullptr)
 
bool actionEnabledState () const
 
void loadTool (EditorTool *const tool)
 
void registerExtraPluginsActions (QString &dom) override
 
- Public Member Functions inherited from Digikam::DXmlGuiWindow
 DXmlGuiWindow (QWidget *const parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 
QList< QAction * > allActions () const
 Return all actions from internal collection.
 
void cleanupActions ()
 Cleanup unwanted actions from action collection.
 
QString configGroupName () const
 
void createFullScreenAction (const QString &name)
 Create Full-screen action to action collection instance from managed window set through setManagedWindow().
 
void createHelpActions (const QString &handbookSection, bool coreOptions=true)
 Create common actions from Help menu for all digiKam main windows.
 
void createSettingsActions ()
 Create common actions to setup all digiKam main windows.
 
void createSidebarActions ()
 Create common actions to handle side-bar through keyboard shortcuts.
 
bool fullScreenIsActive () const
 Return true if managed window is currently in Full Screen Mode.
 
virtual DInfoInterfaceinfoIface (DPluginAction *const ac)=0
 Return the interface instance to access to items information.
 
void readFullScreenSettings (const KConfigGroup &group)
 Read full-screen settings from KDE config file.
 
void registerPluginsActions ()
 Register all generic plugins action to this instance.
 
void setConfigGroupName (const QString &name)
 Manage config group name used by window instance to get/set settings from config file.
 
void setFullScreenOptions (int options)
 Set full-screen options to managed window.
 
void unminimizeAndActivateWindow ()
 

Static Public Attributes

static const QString CONFIG_GROUP_NAME
 

Protected Types

enum  SaveAskMode {
  AskIfNeeded , OverwriteWithoutAsking , AlwaysSaveAs , SaveVersionWithoutAsking = OverwriteWithoutAsking ,
  AlwaysNewVersion = AlwaysSaveAs
}
 

Protected Slots

virtual bool save ()=0
 
virtual bool saveAs ()=0
 
virtual bool saveCurrentVersion ()=0
 
virtual bool saveNewVersion ()=0
 
virtual bool saveNewVersionAs ()=0
 
virtual bool saveNewVersionInFormat (const QString &)=0
 
virtual bool saveOrSaveAs ()
 
void slotAboutToShowRedoMenu ()
 
void slotAboutToShowUndoMenu ()
 
virtual void slotAddedDropedItems (QDropEvent *e)=0
 
virtual void slotBackward ()=0
 
virtual void slotChanged ()=0
 
void slotComponentsInfo () override
 
virtual void slotContextMenu ()=0
 
virtual void slotDeleteCurrentItem ()=0
 
virtual void slotDiscardChanges ()
 
virtual void slotFileOriginChanged (const QString &filePath)
 
virtual void slotFileWithDefaultApplication ()=0
 
virtual void slotFirst ()=0
 
virtual void slotForward ()=0
 
virtual void slotLast ()=0
 
virtual void slotLoadingFinished (const QString &filename, bool success)
 
void slotLoadingProgress (const QString &filePath, float progress)
 
virtual void slotLoadingStarted (const QString &filename)
 
void slotNameLabelCancelButtonPressed ()
 
virtual void slotOpenOriginal ()
 
virtual void slotOpenWith (QAction *action=nullptr)=0
 
virtual void slotPrepareToLoad ()
 
virtual void slotRevert ()=0
 
void slotSavingProgress (const QString &filePath, float progress)
 
virtual void slotSavingStarted (const QString &filename)
 
void slotSelected (bool)
 
virtual void slotUpdateItemInfo ()=0
 
- Protected Slots inherited from Digikam::DXmlGuiWindow
bool slotClose ()
 

Protected Member Functions

virtual void addServicesMenu ()=0
 
void addServicesMenuForUrl (const QUrl &url)
 
void applyColorManagementSettings ()
 
void applyIOSettings ()
 
void applyStandardSettings ()
 
bool checkOverwrite (const QUrl &url)
 
bool checkPermissions (const QUrl &url)
 
void colorManage ()
 
EditorStackVieweditorStackView () const
 
void execSavingProgressDialog ()
 
ExposureSettingsContainerexposureSettings () const
 
virtual void finishSaving (bool success)
 
virtual bool hasOriginalToRestore ()
 
virtual void moveFile ()
 
bool moveLocalFile (const QString &src, const QString &dest)
 
void movingSaveFileFinished (bool successful)
 
void openWith (const QUrl &url, QAction *action)
 
bool promptForOverWrite ()
 
bool promptUserDelete (const QUrl &url)
 
bool promptUserSave (const QUrl &url, SaveAskMode mode=AskIfNeeded, bool allowCancel=true)
 
virtual void readSettings ()
 
void readStandardSettings ()
 
void resetOrigin ()
 
void resetOriginSwitchFile ()
 
virtual DImageHistory resolvedImageHistory (const DImageHistory &history)
 
virtual SidebarrightSideBar () const =0
 
virtual void saveAsIsComplete ()=0
 
VersionFileOperation saveAsVersionFileOperation (const QUrl &url, const QUrl &saveLocation, const QString &format)
 
virtual QUrl saveDestinationUrl ()=0
 Hook method that subclasses must implement to return the destination url of the image to save.
 
VersionFileOperation saveInFormatVersionFileOperation (const QUrl &url, const QString &format)
 
virtual void saveIsComplete ()=0
 
virtual void saveSettings ()
 
void saveStandardSettings ()
 
VersionFileOperation saveVersionFileOperation (const QUrl &url, bool fork)
 
virtual void saveVersionIsComplete ()=0
 
virtual void setupActions ()=0
 
virtual void setupConnections ()=0
 
void setupContextMenu ()
 
void setupSelectToolsAction ()
 
void setupStandardActions ()
 
void setupStandardConnections ()
 
void setupStatusBar ()
 
virtual void setupUserArea ()=0
 
SidebarSplittersidebarSplitter () const
 
void startingSave (const QUrl &url)
 
bool startingSaveAs (const QUrl &url)
 
bool startingSaveCurrentVersion (const QUrl &url)
 
bool startingSaveNewVersion (const QUrl &url)
 
bool startingSaveNewVersionAs (const QUrl &url)
 
bool startingSaveNewVersionInFormat (const QUrl &url, const QString &format)
 
virtual ThumbBarDockthumbBar () const =0
 
virtual void toggleActions (bool val)
 
void toggleNonDestructiveActions ()
 
void toggleStandardActions (bool val)
 
void toggleToolActions (EditorTool *tool=nullptr)
 
void toggleZoomActions (bool val)
 Method used by Editor Tools.
 
virtual VersionManagerversionManager () const
 
bool waitForSavingToComplete ()
 
- Protected Member Functions inherited from Digikam::DXmlGuiWindow
void closeEvent (QCloseEvent *e) override
 
void editKeyboardShortcuts (KActionCollection *const extraac=nullptr, const QString &actitle=QString())
 Call this method from your main window to show keyboard shortcut config dialog with an extra action collection to configure.
 
bool eventFilter (QObject *obj, QEvent *ev) override
 
void keyPressEvent (QKeyEvent *e) override
 
QAction * showMenuBarAction () const
 
QAction * showStatusBarAction () const
 

Protected Attributes

bool m_actionEnabledState = false
 
QAction * m_applyToolAction = nullptr
 
QAction * m_backwardAction = nullptr
 
QColor m_bgColor
 
Canvasm_canvas = nullptr
 
QAction * m_closeToolAction = nullptr
 
QMenu * m_contextMenu = nullptr
 
QAction * m_discardChangesAction = nullptr
 
bool m_editingOriginalImage = true
 
QAction * m_exportAction = nullptr
 
QAction * m_fileDeleteAction = nullptr
 
QAction * m_firstAction = nullptr
 
QString m_formatForRAWVersioning
 
QString m_formatForSubversions
 
QAction * m_forwardAction = nullptr
 
IOFileSettingsm_IOFileSettings = nullptr
 
QAction * m_lastAction = nullptr
 
StatusProgressBarm_nameLabel = nullptr
 
bool m_nonDestructive = true
 
QAction * m_openVersionAction = nullptr
 
KToolBarPopupAction * m_redoAction = nullptr
 
DAdjustableLabelm_resLabel = nullptr
 
QAction * m_revertAction = nullptr
 
QAction * m_saveAction = nullptr
 
QAction * m_saveAsAction = nullptr
 
QAction * m_saveCurrentVersionAction = nullptr
 
KToolBarPopupAction * m_saveNewVersionAction = nullptr
 
QAction * m_saveNewVersionAsAction = nullptr
 
QMenu * m_saveNewVersionInFormatAction = nullptr
 
SavingContext m_savingContext
 
QPointer< QProgressDialog > m_savingProgressDialog = nullptr
 
QAction * m_serviceAction = nullptr
 
QMenu * m_servicesMenu = nullptr
 
bool m_setExifOrientationTag = true
 
QAction * m_showBarAction = nullptr
 
SidebarSplitterm_splitter = nullptr
 
EditorStackViewm_stackView = nullptr
 
QVector< TransformType > m_transformQue
 
KToolBarPopupAction * m_undoAction = nullptr
 
- Protected Attributes inherited from Digikam::DXmlGuiWindow
DLogoActionm_animLogo = nullptr
 

Friends

class EditorToolIface
 

Additional Inherited Members

- Static Public Member Functions inherited from Digikam::DXmlGuiWindow
static QAction * buildStdAction (StdActionType type, const QObject *const recvr, const char *const slot, QObject *const parent)
 
static QString configFullScreenHideSideBarsEntry ()
 
static QString configFullScreenHideStatusBarEntry ()
 
static QString configFullScreenHideThumbBarEntry ()
 
static QString configFullScreenHideToolBarsEntry ()
 Shared with FullScreenSettings.
 
static void restoreWindowSize (QWindow *const win, const KConfigGroup &group)
 
static void saveWindowSize (QWindow *const win, KConfigGroup &group)
 
static void setGoodDefaultWindowSize (QWindow *const win)
 
static void setupIconTheme ()
 If we have some local breeze icon resource, prefer it.
 

Member Function Documentation

◆ registerExtraPluginsActions()

void Digikam::EditorWindow::registerExtraPluginsActions ( QString &  dom)
overridevirtual

Reimplemented from Digikam::DXmlGuiWindow.

◆ saveDestinationUrl()

virtual QUrl Digikam::EditorWindow::saveDestinationUrl ( )
protectedpure virtual

This may also be a remote url.

This method will only be called while saving.

Returns
destination for the file that is currently being saved.

◆ toggleZoomActions()

void Digikam::EditorWindow::toggleZoomActions ( bool  val)
protected

Only tools based on imageregionwidget support zooming. TODO: Fix this behavior when editor tool preview widgets will be factored.

Member Data Documentation

◆ m_transformQue

QVector<TransformType> Digikam::EditorWindow::m_transformQue
protected
Note
using QVector to store transforms