OpenClonk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
C4Window Class Referenceabstract

#include <C4Window.h>

Inheritance diagram for C4Window:
[legend]
Collaboration diagram for C4Window:
[legend]

Public Types

enum  WindowKind {
  W_GuiWindow, W_Console, W_Viewport, W_Fullscreen,
  W_Control
}
 

Public Member Functions

 C4Window ()
 
virtual ~C4Window ()
 
virtual void Clear ()
 
virtual void Close ()=0
 
virtual void CharIn (const char *)
 
virtual bool ReInit (C4AbstractApp *pApp)
 
virtual void EnumerateMultiSamples (std::vector< int > &samples) const
 
bool StorePosition (const char *szWindowName, const char *szSubKey, bool fStoreSize=true)
 
bool RestorePosition (const char *szWindowName, const char *szSubKey, bool fHidden=false)
 
bool GetSize (C4Rect *pRect)
 
void SetSize (unsigned int cx, unsigned int cy)
 
void SetTitle (const char *Title)
 
void FlashWindow ()
 
void GrabMouse (bool grab)
 
virtual void RequestUpdate ()
 
virtual void PerformUpdate ()
 

Public Attributes

bool Active {false}
 
C4SurfacepSurface {nullptr}
 
WindowKind eKind
 

Protected Member Functions

virtual C4WindowInit (WindowKind windowKind, C4AbstractApp *pApp, const char *Title, const C4Rect *size)
 

Friends

class C4Draw
 
class CStdGL
 
class CStdGLCtx
 
class C4AbstractApp
 

Detailed Description

Definition at line 256 of file C4Window.h.

Member Enumeration Documentation

Enumerator
W_GuiWindow 
W_Console 
W_Viewport 
W_Fullscreen 
W_Control 

Definition at line 262 of file C4Window.h.

263  {
264  W_GuiWindow,
265  W_Console,
266  W_Viewport,
267  W_Fullscreen,
268  W_Control // wrapper to a render target control inside a window
269  };

Constructor & Destructor Documentation

C4Window::C4Window ( )
default

Definition at line 38 of file C4WindowSDL.cpp.

38  :
39  Active(false), pSurface(nullptr), eKind(W_Fullscreen), window(nullptr)
40 #ifdef WITH_QT_EDITOR
41 , glwidget(nullptr)
42 #endif
43 {
44 }
C4Surface * pSurface
Definition: C4Window.h:274
WindowKind eKind
Definition: C4Window.h:275
bool Active
Definition: C4Window.h:273
C4Window::~C4Window ( )
virtualdefault

Definition at line 46 of file C4WindowSDL.cpp.

References Clear().

47 {
48  Clear();
49 }
virtual void Clear()
Definition: C4AppT.cpp:99

Here is the call graph for this function:

Member Function Documentation

virtual void C4Window::CharIn ( const char *  )
inlinevirtual

Reimplemented in C4FullScreen.

Definition at line 281 of file C4Window.h.

281 { }
void C4Window::Clear ( )
virtual

Reimplemented in C4Console, and C4FullScreen.

Definition at line 99 of file C4AppT.cpp.

Referenced by C4FullScreen::Clear(), C4Console::Clear(), C4GUI::Dialog::DestroyConsoleWindow(), and ~C4Window().

99 {}

Here is the caller graph for this function:

virtual void C4Window::Close ( )
pure virtual
void C4Window::EnumerateMultiSamples ( std::vector< int > &  samples) const
virtual

Definition at line 102 of file C4AppT.cpp.

Referenced by C4StartupOptionsDlg::C4StartupOptionsDlg().

102 {}

Here is the caller graph for this function:

void C4Window::FlashWindow ( )

Definition at line 74 of file C4AppMac.mm.

Referenced by C4AbstractApp::NotifyUserIfInactive().

75 {
76  [NSApp requestUserAttention:NSCriticalRequest];
77 }

Here is the caller graph for this function:

bool C4Window::GetSize ( C4Rect pRect)

Definition at line 105 of file C4AppT.cpp.

Referenced by C4Application::OnResolutionChanged(), C4GUI::DialogWindow::PerformUpdate(), and C4Game::PreInit().

105 {return false;}

Here is the caller graph for this function:

void C4Window::GrabMouse ( bool  grab)

Definition at line 104 of file C4AppT.cpp.

Referenced by C4Application::GameTick().

104 {}

Here is the caller graph for this function:

C4Window * C4Window::Init ( C4Window::WindowKind  windowKind,
C4AbstractApp pApp,
const char *  Title,
const C4Rect size 
)
protectedvirtual

Definition at line 106 of file C4AppT.cpp.

Referenced by C4ConsoleGUIPreviewWindow::C4ConsoleGUIPreviewWindow(), C4ConsoleGUI::CreateConsoleWindow(), C4ViewportWindow::Init(), and C4GUI::DialogWindow::Init().

106 {return this;}

Here is the caller graph for this function:

void C4Window::PerformUpdate ( )
virtual

Reimplemented in C4GUI::DialogWindow, C4FullScreen, and C4ViewportWindow.

Definition at line 85 of file C4App.cpp.

86 {
87 }
bool C4Window::ReInit ( C4AbstractApp pApp)
virtual

Definition at line 107 of file C4AppT.cpp.

107 {return false;}
void C4Window::RequestUpdate ( )
virtual

Definition at line 109 of file C4AppT.cpp.

Referenced by C4FullScreen::Execute().

109 {}

Here is the caller graph for this function:

bool C4Window::RestorePosition ( const char *  szWindowName,
const char *  szSubKey,
bool  fHidden = false 
)

Definition at line 108 of file C4AppT.cpp.

Referenced by C4ViewportWindow::Init(), and C4GUI::DialogWindow::Init().

108 {return false;}

Here is the caller graph for this function:

void C4Window::SetSize ( unsigned int  cx,
unsigned int  cy 
)

Definition at line 110 of file C4AppT.cpp.

Referenced by C4Application::DoInit(), C4GUI::DialogWindow::Init(), C4AbstractApp::SetVideoMode(), and C4GUI::Dialog::UpdateSize().

110 {}

Here is the caller graph for this function:

void C4Window::SetTitle ( const char *  Title)

Definition at line 111 of file C4AppT.cpp.

Referenced by C4Console::CloseGame(), C4Console::SetCaptionToFilename(), and C4GUI::Dialog::SetTitle().

111 {}

Here is the caller graph for this function:

bool C4Window::StorePosition ( const char *  szWindowName,
const char *  szSubKey,
bool  fStoreSize = true 
)

Definition at line 139 of file C4WindowSDL.cpp.

139 { return true; }

Friends And Related Function Documentation

friend class C4AbstractApp
friend

Definition at line 324 of file C4Window.h.

friend class C4Draw
friend

Definition at line 321 of file C4Window.h.

friend class CStdGL
friend

Definition at line 322 of file C4Window.h.

friend class CStdGLCtx
friend

Definition at line 323 of file C4Window.h.

Member Data Documentation

WindowKind C4Window::eKind

Definition at line 275 of file C4Window.h.


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