ezQtDocumentWindow Class Reference

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

#include <DocumentWindow.moc.h>

Inheritance diagram for ezQtDocumentWindow:

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
ezDocument *	GetDocument () const
ezStatus	SaveDocument ()
bool	CanCloseWindow ()
void	CloseDocumentWindow ()
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

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 ()
virtual void	OnAfterDocumentLayoutRestored ()

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.

OnAfterDocumentLayoutRestored()

virtual void ezQtDocumentWindow::OnAfterDocumentLayoutRestored ( )

inlineprotectedvirtual

Called after a saved dock layout has been restored. Override to re-apply any panel visibility that must not be overridden by old layout files (e.g. panels that are conditionally shown/hidden). The base implementation does nothing.

Reimplemented in ezQtAnimationClipAssetDocumentWindow.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Tools/Libs/GuiFoundation/DocumentWindow/DocumentWindow.moc.h
• /home/runner/work/ezEngine/ezEngine/Code/Tools/Libs/GuiFoundation/DocumentWindow/DocumentWindow.cpp