OpenClonk
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
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, int min_expected=0) 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}
 
C4Surface * pSurface {nullptr}
 
WindowKind eKind
 

Protected Member Functions

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

Friends

class C4Draw
 
class CStdGL
 
class CStdGLCtx
 
class C4AbstractApp
 

Detailed Description

Definition at line 257 of file C4Window.h.

Member Enumeration Documentation

◆ WindowKind

enum C4Window::WindowKind
Enumerator
W_GuiWindow 
W_Console 
W_Viewport 
W_Fullscreen 
W_Control 

Definition at line 263 of file C4Window.h.

264  {
265  W_GuiWindow,
266  W_Console,
267  W_Viewport,
268  W_Fullscreen,
269  W_Control // wrapper to a render target control inside a window
270  };
C4Window::W_Fullscreen
@ W_Fullscreen
Definition: C4Window.h:268
C4Window::W_GuiWindow
@ W_GuiWindow
Definition: C4Window.h:265
C4Window::W_Control
@ W_Control
Definition: C4Window.h:269
C4Window::W_Viewport
@ W_Viewport
Definition: C4Window.h:267
C4Window::W_Console
@ W_Console
Definition: C4Window.h:266

Constructor & Destructor Documentation

◆ C4Window()

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 }
C4Window::pSurface
C4Surface * pSurface
Definition: C4Window.h:275
C4Window::eKind
WindowKind eKind
Definition: C4Window.h:276
C4Window::Active
bool Active
Definition: C4Window.h:274

◆ ~C4Window()

C4Window::~C4Window ( )
virtualdefault

Definition at line 46 of file C4WindowSDL.cpp.

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

References Clear().

Here is the call graph for this function:

Member Function Documentation

◆ CharIn()

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

Reimplemented in C4FullScreen.

Definition at line 282 of file C4Window.h.

282 { }

◆ Clear()

void C4Window::Clear ( )
virtual

Reimplemented in C4FullScreen, and C4Console.

Definition at line 102 of file C4AppT.cpp.

102 {}

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

Here is the caller graph for this function:

◆ Close()

virtual void C4Window::Close ( )
pure virtual

Implemented in C4GUI::DialogWindow, C4FullScreen, C4ViewportWindow, C4ConsoleGUIPreviewWindow, and C4Console.

◆ EnumerateMultiSamples()

void C4Window::EnumerateMultiSamples ( std::vector< int > &  samples,
int  min_expected = 0 
) const
virtual

Definition at line 105 of file C4AppT.cpp.

105 {}

Referenced by C4StartupOptionsDlg::C4StartupOptionsDlg().

Here is the caller graph for this function:

◆ FlashWindow()

void C4Window::FlashWindow ( )

Definition at line 75 of file C4AppMac.mm.

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

Referenced by C4AbstractApp::NotifyUserIfInactive().

Here is the caller graph for this function:

◆ GetSize()

bool C4Window::GetSize ( C4Rect *  pRect)

Definition at line 108 of file C4AppT.cpp.

108 {return false;}

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

Here is the caller graph for this function:

◆ GrabMouse()

void C4Window::GrabMouse ( bool  grab)

Definition at line 107 of file C4AppT.cpp.

107 {}

Referenced by C4Application::GameTick().

Here is the caller graph for this function:

◆ Init()

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

Definition at line 109 of file C4AppT.cpp.

109 {return this;}

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

Here is the caller graph for this function:

◆ PerformUpdate()

void C4Window::PerformUpdate ( )
virtual

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

Definition at line 85 of file C4App.cpp.

86 {
87 }

◆ ReInit()

bool C4Window::ReInit ( C4AbstractApp *  pApp)
virtual

Definition at line 110 of file C4AppT.cpp.

110 {return false;}

◆ RequestUpdate()

void C4Window::RequestUpdate ( )
virtual

Definition at line 112 of file C4AppT.cpp.

112 {}

Referenced by C4FullScreen::Execute().

Here is the caller graph for this function:

◆ RestorePosition()

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

Definition at line 111 of file C4AppT.cpp.

111 {return false;}

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

Here is the caller graph for this function:

◆ SetSize()

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

Definition at line 113 of file C4AppT.cpp.

113 {}

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

Here is the caller graph for this function:

◆ SetTitle()

void C4Window::SetTitle ( const char *  Title)

Definition at line 114 of file C4AppT.cpp.

114 {}

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

Here is the caller graph for this function:

◆ StorePosition()

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

Definition at line 153 of file C4WindowSDL.cpp.

153 { return true; }

Friends And Related Function Documentation

◆ C4AbstractApp

friend class C4AbstractApp
friend

Definition at line 326 of file C4Window.h.

◆ C4Draw

friend class C4Draw
friend

Definition at line 323 of file C4Window.h.

◆ CStdGL

friend class CStdGL
friend

Definition at line 324 of file C4Window.h.

◆ CStdGLCtx

friend class CStdGLCtx
friend

Definition at line 325 of file C4Window.h.

Member Data Documentation

◆ Active

bool C4Window::Active {false}

Definition at line 274 of file C4Window.h.

Referenced by AddMenuItem(), C4Console::C4Console(), C4Console::ClearNetMenu(), C4Console::ClearViewportMenu(), C4Console::CloseGame(), ConsoleDlgProc(), C4Game::DoKeyboardInput(), C4Network2::DoLobby(), C4ConsoleGUI::EnableControls(), C4Console::In(), C4Console::InitGame(), C4Game::InitPlayers(), C4Console::Message(), C4Game::OnResolutionChanged(), C4PlayerInfoList::RestoreSavegameInfos(), C4Network2::RetrieveRes(), C4Console::SaveScenario(), C4GraphicsSystem::ToggleShow8BitSurface(), C4GraphicsSystem::ToggleShowAction(), C4GraphicsSystem::ToggleShowVertices(), C4ConsoleGUI::UpdateHaltCtrls(), C4Console::UpdateMenus(), C4ConsoleGUI::State::UpdateMenuText(), C4Console::UpdateNetMenu(), C4Console::UpdatePlayerMenu(), C4Console::UpdateStatusBars(), C4Console::UpdateViewportMenu(), and C4FullScreen::ViewportCheck().

◆ eKind

WindowKind C4Window::eKind

Definition at line 276 of file C4Window.h.

◆ pSurface

C4Surface* C4Window::pSurface {nullptr}

Definition at line 275 of file C4Window.h.

Referenced by C4ConsoleGUIPreviewWindow::C4ConsoleGUIPreviewWindow(), C4Console::Clear(), C4FullScreen::Clear(), C4GUI::Dialog::CreateConsoleWindow(), C4GUI::Dialog::DestroyConsoleWindow(), C4GraphicsSystem::DoSaveScreenshot(), C4GUI::Dialog::Draw(), C4ViewportList::DrawFullscreenBackground(), C4Viewport::Execute(), C4GraphicsSystem::FinishDrawing(), C4Draw::Init(), C4ViewportWindow::Init(), C4Game::InitFullscreenComponents(), C4MessageBoard::LogNotify(), C4Application::OnResolutionChanged(), C4GUI::DialogWindow::PerformUpdate(), C4Application::PreInit(), C4ViewportList::RecalculateViewports(), C4GUI::Screen::Render(), CStdGL::RestoreDeviceObjects(), C4Game::SaveGameTitle(), C4ConsoleGUIPreviewWindow::~C4ConsoleGUIPreviewWindow(), and C4FullScreen::~C4FullScreen().

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