ezEngine Release 25.08
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Friends | List of all members
ezQtDocumentWindow Class Referenceabstract

Base class for all document windows. Handles the most basic document window management. More...

#include <DocumentWindow.moc.h>

Inheritance diagram for ezQtDocumentWindow:
Inheritance graph
[legend]

Public Member Functions

 ezQtDocumentWindow (ezDocument *pDocument)
 
 ezQtDocumentWindow (const char *szUniqueName)
 
void EnsureVisible ()
 
virtual ezString GetWindowIcon () const
 
virtual ezString GetDisplayName () const
 
virtual ezString GetDisplayNameShort () const
 
const char * GetUniqueName () const
 
virtual const char * GetWindowLayoutGroupName () const =0
 The 'GroupName' is used for serializing window layouts. It should be unique among different window types.
 
ezDocument * GetDocument () const
 
ezStatus SaveDocument ()
 
bool CanCloseWindow ()
 
void CloseDocumentWindow ()
 
void ScheduleRestoreWindowLayout ()
 
bool IsVisibleInContainer () const
 
void SetTargetFramerate (ezInt16 iTargetFPS)
 
void TriggerRedraw ()
 
virtual void RequestWindowTabContextMenu (const QPoint &globalPos)
 
ezQtContainerWindow * GetContainerWindow () const
 
void ShowTemporaryStatusBarMsg (const ezFormatString &text, ezTime duration=ezTime::MakeFromSeconds(5))
 Shows the given message for the given duration in the statusbar, then shows the permanent message again.
 
void SetPermanentStatusBarMsg (const ezFormatString &text)
 Sets which text to show permanently in the statusbar. Set an empty string to clear the message.
 
virtual void CreateImageCapture (const char *szOutputPath)
 For unit tests to take a screenshot of the window (may include multiple views) to do image comparisons.
 

Static Public Member Functions

static const ezDynamicArray< ezQtDocumentWindow * > & GetAllDocumentWindows ()
 
static ezQtDocumentWindow * FindWindowByDocument (const ezDocument *pDocument)
 Returns the document window for the given document, if there is any. nullptr otherwise.
 

Public Attributes

ads::CDockManager * m_pDockManager = nullptr
 

Static Public Attributes

static ezEvent< const ezQtDocumentWindowEvent & > s_Events
 
static bool s_bAllowRestoreWindowLayout = true
 In 'safe' mode we want to prevent the documents from using the stored window layout state.
 

Protected Member Functions

virtual void showEvent (QShowEvent *event) override
 
virtual void hideEvent (QHideEvent *event) override
 
virtual bool event (QEvent *event) override
 
virtual bool eventFilter (QObject *obj, QEvent *e) override
 
void FinishWindowCreation ()
 

Friends

class ezQtContainerWindow
 

Detailed Description

Base class for all document windows. Handles the most basic document window management.

Member Function Documentation

◆ CreateImageCapture()

void ezQtDocumentWindow::CreateImageCapture ( const char *  szOutputPath)
virtual

For unit tests to take a screenshot of the window (may include multiple views) to do image comparisons.

Reimplemented in ezQtEngineDocumentWindow, and ezQtSceneDocumentWindowBase.

◆ GetWindowLayoutGroupName()

virtual const char * ezQtDocumentWindow::GetWindowLayoutGroupName ( ) const
pure virtual

The 'GroupName' is used for serializing window layouts. It should be unique among different window types.

Implemented in ezSoundEventAssetDocumentWindow, ezQtSettingsTab, ezQtAngelScriptAssetDocumentWindow, ezQtAnimatedMeshAssetDocumentWindow, ezQtAnimationClipAssetDocumentWindow, ezQtAnimationGraphAssetDocumentWindow, ezQtBlackboardTemplateAssetDocumentWindow, ezQtCollectionAssetDocumentWindow, ezQtColorGradientAssetDocumentWindow, ezQtCurve1DAssetDocumentWindow, ezQtCustomDataAssetDocumentWindow, ezQtDecalAssetDocumentWindow, ezQtImageDataAssetDocumentWindow, ezQtLUTAssetDocumentWindow, ezQtMaterialAssetDocumentWindow, ezQtMeshAssetDocumentWindow, ezQtPropertyAnimAssetDocumentWindow, ezQtRenderPipelineAssetDocumentWindow, ezQtSkeletonAssetDocumentWindow, ezQtStateMachineAssetDocumentWindow, ezQtSurfaceAssetDocumentWindow, ezQtTextureAssetDocumentWindow, ezQtTextureCubeAssetDocumentWindow, ezSoundBankAssetDocumentWindow, ezQtJoltCollisionMeshAssetDocumentWindow, ezQtKrautTreeAssetDocumentWindow, ezMiniAudioSoundAssetDocumentWindow, ezQtParticleEffectAssetDocumentWindow, ezProcGenGraphAssetDocumentWindow, ezQtRmlUiAssetDocumentWindow, ezQtScene2DocumentWindow, ezQtSceneDocumentWindow, ezQtSubstancePackageAssetWindow, and ezQtVisualScriptWindow.

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