EHS
ehs::BaseWindow Class Referenceabstract

#include <BaseWindow.h>

Inheritance diagram for ehs::BaseWindow:
ehs::Window ehs::Window ehs::Window

Public Member Functions

virtual ~BaseWindow ()=default
 
 BaseWindow ()
 
 BaseWindow (const BaseWindow &win)
 
BaseWindowoperator= (const BaseWindow &win)
 
virtual void Create_32 (const Str_32 &title, const Vec2_s32 &pos, Vec2_u32 scale)=0
 
virtual void Create_16 (const Str_16 &title, const Vec2_s32 &pos, Vec2_u32 scale)=0
 
virtual void Create_8 (const Str_8 &title, const Vec2_s32 &pos, Vec2_u32 scale)=0
 
virtual void OnCreated ()=0
 
virtual void Close ()=0
 
virtual void Show ()=0
 
virtual void Hide ()=0
 
bool IsCreated () const
 
virtual bool Poll ()
 
bool HasFocus () const
 
Vec2_s32 GetCursorPos () const
 
virtual void ShowCursor (bool toggle)=0
 
bool IsCursorVisible () const
 
virtual void ConstrainCursor (bool constrain)=0
 
bool IsCursorConstrained () const
 
WindowState GetState () const
 
const InputHandlerGetInputHandler () const
 
virtual void SetTitle_32 (const Str_32 &newTitle)=0
 
virtual Str_32 GetTitle_32 () const =0
 
virtual void SetTitle_16 (const Str_16 &newTitle)=0
 
virtual Str_16 GetTitle_16 () const =0
 
virtual void SetTitle_8 (const Str_8 &newTitle)=0
 
virtual Str_8 GetTitle_8 () const =0
 
virtual void SetPos (const Vec2_s32 &newPos)=0
 
virtual Vec2_s32 GetPos () const =0
 
virtual void SetScale (const Vec2_u32 &newScale)=0
 
virtual Vec2_u32 GetScale () const =0
 
virtual Serializer< UInt_64 > GetClipboard ()=0
 
virtual void SetClipboard (Serializer< UInt_64 > data)=0
 
virtual void SetCursorImg (CursorImg img)=0
 

Protected Attributes

bool created
 
bool focused
 
Vec2_s32 cursorPos
 
bool cursorVisible
 
bool cursorConstrained
 
WindowState state
 
InputHandler ih
 

Constructor & Destructor Documentation

◆ ~BaseWindow()

virtual ehs::BaseWindow::~BaseWindow ( )
virtualdefault

◆ BaseWindow() [1/2]

ehs::BaseWindow::BaseWindow ( )

◆ BaseWindow() [2/2]

ehs::BaseWindow::BaseWindow ( const BaseWindow win)

Member Function Documentation

◆ Close()

virtual void ehs::BaseWindow::Close ( )
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ ConstrainCursor()

virtual void ehs::BaseWindow::ConstrainCursor ( bool  constrain)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ Create_16()

virtual void ehs::BaseWindow::Create_16 ( const Str_16 title,
const Vec2_s32 pos,
Vec2_u32  scale 
)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ Create_32()

virtual void ehs::BaseWindow::Create_32 ( const Str_32 title,
const Vec2_s32 pos,
Vec2_u32  scale 
)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ Create_8()

virtual void ehs::BaseWindow::Create_8 ( const Str_8 title,
const Vec2_s32 pos,
Vec2_u32  scale 
)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ GetClipboard()

virtual Serializer< UInt_64 > ehs::BaseWindow::GetClipboard ( )
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ GetCursorPos()

Vec2_s32 ehs::BaseWindow::GetCursorPos ( ) const

Gets the cursors position on the desktop in pixels.

Parameters
[in]relativeWhether the position should be relative to the windows client.
Returns
The current value.

◆ GetInputHandler()

const InputHandler * ehs::BaseWindow::GetInputHandler ( ) const

◆ GetPos()

virtual Vec2_s32 ehs::BaseWindow::GetPos ( ) const
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ GetScale()

virtual Vec2_u32 ehs::BaseWindow::GetScale ( ) const
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ GetState()

WindowState ehs::BaseWindow::GetState ( ) const

◆ GetTitle_16()

virtual Str_16 ehs::BaseWindow::GetTitle_16 ( ) const
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ GetTitle_32()

virtual Str_32 ehs::BaseWindow::GetTitle_32 ( ) const
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ GetTitle_8()

virtual Str_8 ehs::BaseWindow::GetTitle_8 ( ) const
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ HasFocus()

bool ehs::BaseWindow::HasFocus ( ) const

◆ Hide()

virtual void ehs::BaseWindow::Hide ( )
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ IsCreated()

bool ehs::BaseWindow::IsCreated ( ) const

◆ IsCursorConstrained()

bool ehs::BaseWindow::IsCursorConstrained ( ) const

◆ IsCursorVisible()

bool ehs::BaseWindow::IsCursorVisible ( ) const

Checks whether the cursor is shown.

Returns
The current status.

◆ OnCreated()

virtual void ehs::BaseWindow::OnCreated ( )
pure virtual

Implemented in ehs::Window.

◆ operator=()

BaseWindow & ehs::BaseWindow::operator= ( const BaseWindow win)

◆ Poll()

bool ehs::BaseWindow::Poll ( )
virtual

Reimplemented in ehs::Window, ehs::Window, and ehs::Window.

◆ SetClipboard()

virtual void ehs::BaseWindow::SetClipboard ( Serializer< UInt_64 >  data)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ SetCursorImg()

virtual void ehs::BaseWindow::SetCursorImg ( CursorImg  img)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ SetPos()

virtual void ehs::BaseWindow::SetPos ( const Vec2_s32 newPos)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ SetScale()

virtual void ehs::BaseWindow::SetScale ( const Vec2_u32 newScale)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ SetTitle_16()

virtual void ehs::BaseWindow::SetTitle_16 ( const Str_16 newTitle)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ SetTitle_32()

virtual void ehs::BaseWindow::SetTitle_32 ( const Str_32 newTitle)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ SetTitle_8()

virtual void ehs::BaseWindow::SetTitle_8 ( const Str_8 newTitle)
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ Show()

virtual void ehs::BaseWindow::Show ( )
pure virtual

Implemented in ehs::Window, ehs::Window, and ehs::Window.

◆ ShowCursor()

virtual void ehs::BaseWindow::ShowCursor ( bool  toggle)
pure virtual

Shows the cursor on the window.

Parameters
[in]toggleThe new status.

Implemented in ehs::Window, ehs::Window, and ehs::Window.

Member Data Documentation

◆ created

bool ehs::BaseWindow::created
protected

◆ cursorConstrained

bool ehs::BaseWindow::cursorConstrained
protected

◆ cursorPos

Vec2_s32 ehs::BaseWindow::cursorPos
protected

◆ cursorVisible

bool ehs::BaseWindow::cursorVisible
protected

◆ focused

bool ehs::BaseWindow::focused
protected

◆ ih

InputHandler ehs::BaseWindow::ih
protected

◆ state

WindowState ehs::BaseWindow::state
protected

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