XII Release 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Friends | List of all members
xiiQtDocumentWindow Class Referenceabstract

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

#include <DocumentWindow.moc.h>

Inheritance diagram for xiiQtDocumentWindow:
[legend]

Public Member Functions

 xiiQtDocumentWindow (xiiDocument *pDocument)
 
 xiiQtDocumentWindow (xiiStringView sUniqueName)
 
void EnsureVisible ()
 
virtual xiiString GetWindowIcon () const
 
virtual xiiString GetDisplayName () const
 
virtual xiiString GetDisplayNameShort () const
 
xiiStringView GetUniqueName () const
 
virtual xiiStringView GetWindowLayoutGroupName () const =0
 The 'GroupName' is used for serializing window layouts. It should be unique among different window types.
 
xiiDocument * GetDocument () const
 
xiiStatus SaveDocument ()
 
bool CanCloseWindow ()
 
void CloseDocumentWindow ()
 
void ScheduleRestoreWindowLayout ()
 
bool IsVisibleInContainer () const
 
void SetTargetFrameRate (xiiUInt16 uiTargetFPS)
 
void SetTargetFrameRateUnfocused (xiiUInt16 uiTargetFPS)
 
void TriggerRedraw ()
 
virtual void RequestWindowTabContextMenu (const QPoint &globalPos)
 
xiiQtContainerWindow * GetContainerWindow () const
 
void ShowTemporaryStatusBarMsg (const xiiFormatString &text, xiiTime duration=xiiTime::MakeFromSeconds(5))
 Shows the given message for the given duration in the statusbar, then shows the permanent message again.
 
void SetPermanentStatusBarMsg (const xiiFormatString &text)
 Sets which text to show permanently in the statusbar. Set an empty string to clear the message.
 
virtual void CreateImageCapture (xiiStringView sOutputPath)
 For unit tests to take a screenshot of the window (may include multiple views) to do image comparisons.
 

Static Public Member Functions

static const xiiDynamicArray< xiiQtDocumentWindow * > & GetAllDocumentWindows ()
 
static xiiQtDocumentWindow * FindWindowByDocument (const xiiDocument *pDocument)
 

Public Attributes

ads::CDockManager * m_pDockManager = nullptr
 

Static Public Attributes

static xiiEvent< const xiiQtDocumentWindowEvent & > 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 xiiQtContainerWindow
 

Detailed Description

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

Member Function Documentation

◆ CreateImageCapture()

void xiiQtDocumentWindow::CreateImageCapture ( xiiStringView sOutputPath)
virtual

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

Reimplemented in xiiQtEngineDocumentWindow, and xiiQtSceneDocumentWindowBase.

◆ GetWindowLayoutGroupName()

virtual xiiStringView xiiQtDocumentWindow::GetWindowLayoutGroupName ( ) const
pure virtual

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

Implemented in xiiQtAnimatedMeshAssetDocumentWindow, xiiQtAnimationClipAssetDocumentWindow, xiiQtAnimationGraphAssetDocumentWindow, xiiQtBlackboardTemplateAssetDocumentWindow, xiiQtCollectionAssetDocumentWindow, xiiQtColorGradientAssetDocumentWindow, xiiQtCurve1DAssetDocumentWindow, xiiQtCustomDataAssetDocumentWindow, xiiQtDecalAssetDocumentWindow, xiiQtImageDataAssetDocumentWindow, xiiQtLUTAssetDocumentWindow, xiiQtMaterialAssetDocumentWindow, xiiQtMeshAssetDocumentWindow, xiiQtPropertyAnimAssetDocumentWindow, xiiQtRenderPipelineAssetDocumentWindow, xiiQtScene2DocumentWindow, xiiQtSceneDocumentWindow, xiiQtSettingsTab, xiiQtSkeletonAssetDocumentWindow, xiiQtStateMachineAssetDocumentWindow, xiiQtSurfaceAssetDocumentWindow, xiiQtTextureAssetDocumentWindow, xiiQtTextureCubeAssetDocumentWindow, and xiiQtVisualScriptWindow.

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