Plasma Engine  2.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
plQtDocumentWindow Class Referenceabstract

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

#include <DocumentWindow.moc.h>

Inheritance diagram for plQtDocumentWindow:
Inheritance graph
[legend]

Public Member Functions

 plQtDocumentWindow (plDocument *pDocument)
 
 plQtDocumentWindow (const char *szUniqueName)
 
void EnsureVisible ()
 
virtual plString GetWindowIcon () const
 
virtual plString GetDisplayName () const
 
virtual plString 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.
 
plDocument * GetDocument () const
 
plStatus SaveDocument ()
 
bool CanCloseWindow ()
 
void CloseDocumentWindow ()
 
void ScheduleRestoreWindowLayout ()
 
bool IsVisibleInContainer () const
 
void SetTargetFramerate (plInt16 iTargetFPS)
 
void TriggerRedraw ()
 
virtual void RequestWindowTabContextMenu (const QPoint &globalPos)
 
plQtContainerWindow * GetContainerWindow () const
 
void ShowTemporaryStatusBarMsg (const plFormatString &text, plTime duration=plTime::MakeFromSeconds(5))
 Shows the given message for the given duration in the statusbar, then shows the permanent message again.
 
void SetPermanentStatusBarMsg (const plFormatString &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 plDynamicArray< plQtDocumentWindow * > & GetAllDocumentWindows ()
 
static plQtDocumentWindow * FindWindowByDocument (const plDocument *pDocument)
 

Static Public Attributes

static plEvent< const plQtDocumentWindowEvent & > 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 plQtContainerWindow
 

Detailed Description

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

Member Function Documentation

◆ CreateImageCapture()

void plQtDocumentWindow::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 plQtSceneDocumentWindowBase.

◆ GetWindowLayoutGroupName()

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

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

Implemented in plProcGenGraphAssetDocumentWindow, plQtAmplitudeAudioControlCollectionAssetDocumentWindow, plQtAnimatedMeshAssetDocumentWindow, plQtAnimationClipAssetDocumentWindow, plQtAnimationGraphAssetDocumentWindow, plQtBlackboardTemplateAssetDocumentWindow, plQtCollectionAssetDocumentWindow, plQtColorGradientAssetDocumentWindow, plQtCurve1DAssetDocumentWindow, plQtCustomDataAssetDocumentWindow, plQtDecalAssetDocumentWindow, plQtImageDataAssetDocumentWindow, plQtJoltCollisionMeshAssetDocumentWindow, plQtKrautTreeAssetDocumentWindow, plQtLUTAssetDocumentWindow, plQtMaterialAssetDocumentWindow, plQtMeshAssetDocumentWindow, plQtParticleEffectAssetDocumentWindow, plQtPropertyAnimAssetDocumentWindow, plQtRenderPipelineAssetDocumentWindow, plQtRmlUiAssetDocumentWindow, plQtScene2DocumentWindow, plQtSceneDocumentWindow, plQtSettingsTab, plQtSkeletonAssetDocumentWindow, plQtStateMachineAssetDocumentWindow, plQtSubstancePackageAssetWindow, plQtSurfaceAssetDocumentWindow, plQtTextureAssetDocumentWindow, plQtTextureCubeAssetDocumentWindow, plQtTypeScriptAssetDocumentWindow, plQtVisualScriptWindow, plSoundBankAssetDocumentWindow, and plSoundEventAssetDocumentWindow.

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