C4Window Class Reference

#include <C4Window.h>

Inheritance diagram for C4Window:

Collaboration diagram for C4Window:

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}
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 256 of file C4Window.h.

Member Enumeration Documentation

enum C4Window::WindowKind

Enumerator
W_GuiWindow
W_Console
W_Viewport
W_Fullscreen
W_Control

Definition at line 262 of file C4Window.h.

    {
        W_GuiWindow,
        W_Console,
        W_Viewport,
        W_Fullscreen,
        W_Control // wrapper to a render target control inside a window
    };

Constructor & Destructor Documentation

C4Window::C4Window ( )

default

Definition at line 38 of file C4WindowSDL.cpp.

                   :
        Active(false), pSurface(nullptr), eKind(W_Fullscreen), window(nullptr)
#ifdef WITH_QT_EDITOR
, glwidget(nullptr)
#endif
{
}

C4Window::~C4Window ( )

virtualdefault

Definition at line 46 of file C4WindowSDL.cpp.

References Clear().

{
    Clear();
}

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.

{ }

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().

{}

Here is the caller graph for this function:

virtual void C4Window::Close ( )

pure virtual

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

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

virtual

Definition at line 102 of file C4AppT.cpp.

Referenced by C4StartupOptionsDlg::C4StartupOptionsDlg().

{}

Here is the caller graph for this function:

void C4Window::FlashWindow

(

)

Definition at line 74 of file C4AppMac.mm.

Referenced by C4AbstractApp::NotifyUserIfInactive().

{
    [NSApp requestUserAttention:NSCriticalRequest];
}

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().

{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().

{}

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().

{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.

{
}

bool C4Window::ReInit ( C4AbstractApp *  pApp )

virtual

Definition at line 107 of file C4AppT.cpp.

{return false;}

void C4Window::RequestUpdate ( )

virtual

Definition at line 109 of file C4AppT.cpp.

Referenced by C4FullScreen::Execute().

{}

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().

{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().

{}

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().

{}

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.

{ 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

bool C4Window::Active {false}

Definition at line 273 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().

WindowKind C4Window::eKind

Definition at line 275 of file C4Window.h.

C4Surface* C4Window::pSurface {nullptr}

Definition at line 274 of file C4Window.h.

Referenced by C4ConsoleGUIPreviewWindow::C4ConsoleGUIPreviewWindow(), C4FullScreen::Clear(), C4Console::Clear(), C4GUI::Dialog::CreateConsoleWindow(), C4GUI::Dialog::DestroyConsoleWindow(), C4GraphicsSystem::DoSaveScreenshot(), C4GUI::Dialog::Draw(), C4ViewportList::DrawFullscreenBackground(), C4Viewport::Execute(), C4GraphicsSystem::FinishDrawing(), C4ViewportWindow::Init(), C4Draw::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:

• C4Window.h
• C4App.cpp
• C4AppMac.mm
• C4AppT.cpp
• C4WindowSDL.cpp
• C4WindowWin32.cpp