PLGui::Screen Class Reference

Screen class. More...

#include <Screen.h>

List of all members.

Public Member Functions
PLGUI_API	Screen (Gui *pGui)
	Constructor.
PLGUI_API	~Screen ()
	Destructor.
PLGUI_API Gui *	GetGui () const
	Get owner GUI.
PLGUI_API PLCore::String	GetName () const
	Get screen name.
PLGUI_API void	SetName (const PLCore::String &sName)
	Set screen name.
PLGUI_API PLMath::Vector2i	GetPos () const
	Get screen position.
PLGUI_API void	SetPos (const PLMath::Vector2i &vPos)
	Set screen position.
PLGUI_API PLMath::Vector2i	GetSize () const
	Get screen size.
PLGUI_API void	SetSize (const PLMath::Vector2i &vSize)
	Set screen size.
PLGUI_API bool	IsDefault () const
	Check if this is the default screen.
PLGUI_API void	SetDefault (bool bDefault)
	Set if this is the default screen.

---

Detailed Description

Screen class.

Remarks:

This class represents a physical or logical screen (e.g. a monitor device)

---

Constructor & Destructor Documentation

PLGUI_API PLGui::Screen::Screen

(

Gui *

pGui

)

Constructor.

Parameters:

[in]

pGui

Pointer to the owner GUI

PLGUI_API PLGui::Screen::~Screen

(

)

Destructor.

---

Member Function Documentation

PLGUI_API Gui* PLGui::Screen::GetGui

(

)

const

Get owner GUI.

Returns:

GUI

PLGUI_API PLCore::String PLGui::Screen::GetName

(

)

const

Get screen name.

Returns:

Name of screen (this depends on the system)

PLGUI_API void PLGui::Screen::SetName

(

const PLCore::String &

sName

)

Set screen name.

Parameters:

[in]

sName

Name of screen

PLGUI_API PLMath::Vector2i PLGui::Screen::GetPos

(

)

const

Get screen position.

Returns:

Screen position (upper/left corner)

PLGUI_API void PLGui::Screen::SetPos

(

const PLMath::Vector2i &

vPos

)

Set screen position.

Parameters:

[in]

vPos

Screen size (x, y)

PLGUI_API PLMath::Vector2i PLGui::Screen::GetSize

(

)

const

Get screen size.

Returns:

Screen size (width, height)

PLGUI_API void PLGui::Screen::SetSize

(

const PLMath::Vector2i &

vSize

)

Set screen size.

Parameters:

[in]

vSize

Screen size (width, height)

PLGUI_API bool PLGui::Screen::IsDefault

(

)

const

Check if this is the default screen.

Returns:

'true', if the screen is the default screen

PLGUI_API void PLGui::Screen::SetDefault

(

bool

bDefault

)

Set if this is the default screen.

Parameters:

[in]

bDefault

'true', if the screen is the default screen

---

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

• Screen.h