#include <Face.h>

Inheritance diagram for fl7::faces::Face:

Public Types
enum	Anchor { None = 0, Left = 1, Right = 2, Top = 4, Bottom = 8, All = 0xffffffff }
typedef xl7::direct3d::fonts::TextStyle	TextStyle
Public Member Functions
virtual	~Face (void)
unsigned	GetFaceClassID () const
bool	IsCollection () const
bool	IsControl () const
bool	IsStatic () const
bool	IsContainer () const
bool	IsFusion () const
bool	IsButton () const
bool	IsCheckBox () const
bool	IsEditBox () const
bool	IsRadioButton () const
bool	IsSlider () const
bool	IsLabel () const
bool	IsProgressBar () const
bool	IsGroupBox () const
bool	IsDropDownBox () const
bool	IsListBox () const
bool	IsScrollable () const
bool	IsScrollBar () const
bool	IsWindow () const
bool	IsFrame () const
bool	IsPopup () const
bool	IsDialog () const
Shell *	GetShell () const
input::Mouse &	GetMouse ()
input::Keyboard &	GetKeyboard ()
xl7::direct3d::fonts::Font &	GetFont () const
const cl7::string_type &	GetName () const
Collection *	GetParent () const
Window *	GetTopWindow ()
bool	IsEnabled () const
bool	IsVisible () const
bool	IsPassiveModeEnabled () const
bool	IsPassivelyEnabled () const
bool	HasFocus () const
const ml7::Vector2 &	GetPosition () const
const ml7::Vector2 &	GetSize () const
float	GetWidth () const
float	GetHeight () const
float	GetLeft () const
float	GetTop () const
float	GetRight () const
float	GetBottom () const
Anchor	GetAnchor () const
bool	HasAnchor (Anchor anchor) const
virtual bool	CanHaveFocus () const
virtual bool	HighlightOnFocus () const
virtual bool	HighlightOnHover () const
D3DCOLOR	GetColor () const
float	GetRefHeight () const
const TextStyle &	GetTextStyle () const
const Image &	GetCursorImage () const
void *	GetUserData () const
ml7::Vector2	GetAbsolutePosition () const
virtual ml7::Vector2	GetAbsolutePosition (const ml7::Vector2 &client_position) const
virtual ml7::Vector2	GetClientPosition (const ml7::Vector2 &absolute_position) const
bool	IsInside (const ml7::Vector2 &absolute_position) const
FaceFactory *	GetFaceFactory () const
void	SetName (const cl7::string_type &name)
void	SetPosition (const ml7::Vector2 &position)
void	SetSize (const ml7::Vector2 &size)
void	SetAnchor (Anchor anchor)
void	CanHaveFocus (const bool can_have_focus)
void	HighlightOnFocus (const bool highlight_on_focus)
void	HighlightOnHover (const bool highlight_on_hover)
void	SetColor (const D3DCOLOR color)
void	SetRefHeight (const float ref_height)
void	SetTextStyle (const TextStyle &text_style)
TextStyle &	UpdateTextStyle ()
void	SetCursorImage (const Image &cursor_image)
Image &	UpdateCursorImage ()
void	SetUserData (void *user_data)
void	AddAnchor (Anchor anchor)
void	RemoveAnchor (Anchor anchor)
void	Enable ()
void	Disable ()
void	Show ()
void	Hide ()
void	EnablePassiveMode ()
void	DisablePassiveMode ()
void	SetFocus ()
void	LoseFocus ()
void	UpdateDisplay ()
Public Attributes
events::EventHandler < events::EventArgs >	OnEnableEventHandler
events::EventHandler < events::EventArgs >	OnDisableEventHandler
events::EventHandler < events::EventArgs >	OnShowEventHandler
events::EventHandler < events::EventArgs >	OnHideEventHandler
events::EventHandler < events::EventArgs >	OnEnablePassiveModeEventHandler
events::EventHandler < events::EventArgs >	OnDisablePassiveModeEventHandler
events::EventHandler < events::FocusEventArgs >	OnGetFocusEventHandler
events::EventHandler < events::FocusEventArgs >	OnLoseFocusEventHandler
events::EventHandler < events::EventArgs >	OnUpdateDisplayEventHandler
events::EventHandler < events::PositionEventArgs >	OnMoveEventHandler
events::EventHandler < events::PositionEventArgs >	OnResizeEventHandler
events::EventHandler < events::MouseEventArgs >	OnMouseMoveEventHandler
events::EventHandler < events::MouseEventArgs >	OnMouseHoverEventHandler
events::EventHandler < events::MouseEventArgs >	OnMouseEnterEventHandler
events::EventHandler < events::MouseEventArgs >	OnMouseLeaveEventHandler
events::EventHandler < events::MouseButtonEventArgs >	OnMouseButtonDownEventHandler
events::EventHandler < events::MouseButtonEventArgs >	OnMouseButtonUpEventHandler
events::EventHandler < events::MouseButtonEventArgs >	OnMouseButtonPressedEventHandler
events::EventHandler < events::KeyEventArgs >	OnKeyDownEventHandler
events::EventHandler < events::KeyEventArgs >	OnKeyUpEventHandler
events::EventHandler < events::KeyEventArgs >	OnKeyPressedEventHandler
friend	FaceFriend
friend	Collection
friend	_FaceFactory
friend	Shell
Static Public Attributes
static const unsigned	FACE = 0x00000001
static const unsigned	COLLECTION = 0x00000002 \| FACE
static const unsigned	CONTROL = 0x00000004 \| FACE
static const unsigned	STATIC = 0x00000008 \| FACE
static const unsigned	CONTAINER = 0x00000010 \| COLLECTION
static const unsigned	FUSION = 0x00000020 \| COLLECTION
static const unsigned	BUTTON = 0x01000000 \| CONTROL
static const unsigned	CHECKBOX = 0x02000000 \| CONTROL
static const unsigned	EDITBOX = 0x03000000 \| CONTROL
static const unsigned	RADIOBUTTON = 0x04000000 \| CONTROL
static const unsigned	SLIDER = 0x05000000 \| CONTROL
static const unsigned	LABEL = 0x06000000 \| STATIC
static const unsigned	PROGRESSBAR = 0x07000000 \| STATIC
static const unsigned	PICTUREBOX = 0x08000000 \| STATIC
static const unsigned	GROUPBOX = 0x09000000 \| CONTAINER
static const unsigned	DROPDOWNBOX = 0x0a000000 \| FUSION
static const unsigned	LISTBOX = 0x0b000000 \| FUSION
static const unsigned	SCROLLABLE = 0x0c000000 \| FUSION
static const unsigned	SCROLLBAR = 0x0d000000 \| FUSION
static const unsigned	WINDOW = 0x00000040 \| FUSION
static const unsigned	FRAME = 0x00000080 \| WINDOW
static const unsigned	POPUP = 0x0e000000 \| WINDOW
static const unsigned	DIALOG = 0x0f000000 \| FRAME
Protected Member Functions
	Face (const unsigned face_class_id, Shell *const shell, const Config::Face &cfg)
virtual void	_SetParent (Collection *parent)

Detailed Description

The base class for any GUI elements (faces).

Member Typedef Documentation

typedef xl7::direct3d::fonts::TextStyle fl7::faces::Face::TextStyle

Member Enumeration Documentation

enum fl7::faces::Face::Anchor

Enumerator:

None
Left
Right
Top
Bottom
All

Constructor & Destructor Documentation

fl7::faces::Face::Face	(	const unsigned	face_class_id,
		Shell *const	shell,
		const Config::Face &	cfg
	)			`[explicit, protected]`

Explicit constructor.

fl7::faces::Face::~Face ( void ) [virtual]

Destructor.

Member Function Documentation

virtual void fl7::faces::Face::_SetParent ( Collection * parent ) [inline, protected, virtual]

Sets the parent collection face.

void fl7::faces::Face::AddAnchor ( Anchor anchor )

Adds an anchor to this face.

virtual bool fl7::faces::Face::CanHaveFocus ( ) const [inline, virtual]

Returns the flag specifying whether this face can be focused.

void fl7::faces::Face::CanHaveFocus ( const bool can_have_focus ) [inline]

Sets the flag specifying whether this face can be focused.

void fl7::faces::Face::Disable ( )

Disables this face.

void fl7::faces::Face::DisablePassiveMode ( )

Disables passive mode for this face.

void fl7::faces::Face::Enable ( )

Enables this face.

void fl7::faces::Face::EnablePassiveMode ( )

Enables passive mode for this face.

ml7::Vector2 fl7::faces::Face::GetAbsolutePosition ( const ml7::Vector2 & client_position ) const [virtual]

Returns the absolute position of a given client position.

ml7::Vector2 fl7::faces::Face::GetAbsolutePosition ( ) const

Returns the absolute position of the upper-left corner of this face.

Anchor fl7::faces::Face::GetAnchor ( ) const [inline]

Returns the anchor(s) of this face.

float fl7::faces::Face::GetBottom ( ) const [inline]

Returns the bottom position of this face.

ml7::Vector2 fl7::faces::Face::GetClientPosition ( const ml7::Vector2 & absolute_position ) const [virtual]

Returns the client position of a given absolute position.

D3DCOLOR fl7::faces::Face::GetColor ( ) const [inline]

Returns the color to mix up the texture with (default 0xffffffff).

const Image& fl7::faces::Face::GetCursorImage ( ) const [inline]

Returns the image describing an alternative appearance of the mouse cursor while hovering over this face.

unsigned fl7::faces::Face::GetFaceClassID ( ) const [inline]

Returns the face class ID.

FaceFactory* fl7::faces::Face::GetFaceFactory ( ) const [inline]

Returns the "flag" specifying whether this face has been created using the new operator (NULL) or through a face factory (valid face factory object).

xl7::direct3d::fonts::Font & fl7::faces::Face::GetFont ( ) const

Returns the font for displaying text.

float fl7::faces::Face::GetHeight ( ) const [inline]

Returns the height of this face.

input::Keyboard & fl7::faces::Face::GetKeyboard ( )

Returns the keyboard.

float fl7::faces::Face::GetLeft ( ) const [inline]

Returns the left position of this face.

input::Mouse & fl7::faces::Face::GetMouse ( )

Returns the mouse.

const cl7::string_type& fl7::faces::Face::GetName ( ) const [inline]

Returns the name of this face being preferably unique.

Collection* fl7::faces::Face::GetParent ( ) const [inline]

Returns the parent collection face (or NULL if top-window).

const ml7::Vector2& fl7::faces::Face::GetPosition ( ) const [inline]

Returns the position of this face.

Reimplemented in fl7::faces::ProgressBar.

float fl7::faces::Face::GetRefHeight ( ) const [inline]

Returns the reference (line/text/what ever) height.

float fl7::faces::Face::GetRight ( ) const [inline]

Returns the right position of this face.

Shell* fl7::faces::Face::GetShell ( ) const [inline]

Returns the shell object containing and managing this face.

const ml7::Vector2& fl7::faces::Face::GetSize ( ) const [inline]

Returns the size of this face.

const TextStyle& fl7::faces::Face::GetTextStyle ( ) const [inline]

Returns the style of text to display.

float fl7::faces::Face::GetTop ( ) const [inline]

Returns the top position of this face.

Window * fl7::faces::Face::GetTopWindow ( )

Returns the top window (or NULL if top-window).

void* fl7::faces::Face::GetUserData ( ) const [inline]

Returns the user data of this face.

float fl7::faces::Face::GetWidth ( ) const [inline]

Returns the width of this face.

bool fl7::faces::Face::HasAnchor ( Anchor anchor ) const [inline]

Returns true, if the anchor of this face includes the given anchor.

bool fl7::faces::Face::HasFocus ( ) const

Checks whether this face has got the focus.

void fl7::faces::Face::Hide ( )

Hides this face (makes it unvisible).

virtual bool fl7::faces::Face::HighlightOnFocus ( ) const [inline, virtual]

Returns the flag specifying whether this face should be highlighted when focused.

void fl7::faces::Face::HighlightOnFocus ( const bool highlight_on_focus ) [inline]

Sets the flag specifying whether this face should be highlighted when focused.

void fl7::faces::Face::HighlightOnHover ( const bool highlight_on_hover ) [inline]

Sets the flag specifying whether this face should be highlighted when the is hovering over it.

virtual bool fl7::faces::Face::HighlightOnHover ( ) const [inline, virtual]

Returns the flag specifying whether this face should be highlighted when the is hovering over it.

bool fl7::faces::Face::IsButton ( ) const [inline]

Returns true, if this face is a button.

bool fl7::faces::Face::IsCheckBox ( ) const [inline]

Returns true, if this face is a check box.

bool fl7::faces::Face::IsCollection ( ) const [inline]

Returns true, if this face is a collection.

bool fl7::faces::Face::IsContainer ( ) const [inline]

Returns true, if this face is a container.

bool fl7::faces::Face::IsControl ( ) const [inline]

Returns true, if this face is a control.

bool fl7::faces::Face::IsDialog ( ) const [inline]

Returns true, if this face is a dialog.

bool fl7::faces::Face::IsDropDownBox ( ) const [inline]

Returns true, if this face is a drop down box.

bool fl7::faces::Face::IsEditBox ( ) const [inline]

Returns true, if this face is an edit box.

bool fl7::faces::Face::IsEnabled ( ) const [inline]

Returns the flag indicating whether this face is enabled.

bool fl7::faces::Face::IsFrame ( ) const [inline]

Returns true, if this face is a frame window.

bool fl7::faces::Face::IsFusion ( ) const [inline]

Returns true, if this face is a fusion.

bool fl7::faces::Face::IsGroupBox ( ) const [inline]

Returns true, if this face is a group box.

bool fl7::faces::Face::IsInside ( const ml7::Vector2 & absolute_position ) const

Returns true, if a given point in absolute coordinates is inside this face.

bool fl7::faces::Face::IsLabel ( ) const [inline]

Returns true, if this face is a label.

bool fl7::faces::Face::IsListBox ( ) const [inline]

Returns true, if this face is a list box.

bool fl7::faces::Face::IsPassivelyEnabled ( ) const [inline]

Returns true, if this face is enabled and in passive mode.

bool fl7::faces::Face::IsPassiveModeEnabled ( ) const [inline]

Returns the flag indicating whether this face is in passive mode.

bool fl7::faces::Face::IsPopup ( ) const [inline]

Returns true, if this face is a popup window.

bool fl7::faces::Face::IsProgressBar ( ) const [inline]

Returns true, if this face is a progress bar.

bool fl7::faces::Face::IsRadioButton ( ) const [inline]

Returns true, if this face is a radio button.

bool fl7::faces::Face::IsScrollable ( ) const [inline]

Returns true, if this face is a scrollable element.

Reimplemented in fl7::faces::ListBox.

bool fl7::faces::Face::IsScrollBar ( ) const [inline]

Returns true, if this face is a scroll bar.

bool fl7::faces::Face::IsSlider ( ) const [inline]

Returns true, if this face is a slider.

bool fl7::faces::Face::IsStatic ( ) const [inline]

Returns true, if this face is a static element.

bool fl7::faces::Face::IsVisible ( ) const [inline]

Returns the flag indicating whether this face is visible.

bool fl7::faces::Face::IsWindow ( ) const [inline]

Returns true, if this face is a window.

void fl7::faces::Face::LoseFocus ( )

Lets this face lose its focus.

void fl7::faces::Face::RemoveAnchor ( Anchor anchor )

Removes an anchor from this face.

void fl7::faces::Face::SetAnchor ( Anchor anchor ) [inline]

Sets the anchor(s) of this face.

void fl7::faces::Face::SetColor ( const D3DCOLOR color ) [inline]

Sets the color to mix up the texture with (default 0xffffffff).

void fl7::faces::Face::SetCursorImage ( const Image & cursor_image ) [inline]

Sets the image describing an alternative appearance of the mouse cursor while hovering over this face.

void fl7::faces::Face::SetFocus ( )

Lets this face get the focus.

void fl7::faces::Face::SetName ( const cl7::string_type & name ) [inline]

Sets the name of this face being preferably unique.

void fl7::faces::Face::SetPosition ( const ml7::Vector2 & position )

Sets the position of this face.

void fl7::faces::Face::SetRefHeight ( const float ref_height ) [inline]

Sets the reference (line/text/what ever) height.

void fl7::faces::Face::SetSize ( const ml7::Vector2 & size )

Sets the size of this face.

void fl7::faces::Face::SetTextStyle ( const TextStyle & text_style ) [inline]

Sets the style of text to display.

void fl7::faces::Face::SetUserData ( void * user_data ) [inline]

Sets the user data of this face.

void fl7::faces::Face::Show ( )

Shows this face (makes it visible).

Image& fl7::faces::Face::UpdateCursorImage ( ) [inline]

Returns the image describing an alternative appearance of the mouse cursor while hovering over this face, so you can update it.

void fl7::faces::Face::UpdateDisplay ( )

Updates the contents of this face and stuff like that.

TextStyle& fl7::faces::Face::UpdateTextStyle ( ) [inline]

Returns the style of the text to display, so you can update it.

Member Data Documentation

friend fl7::faces::Face::_FaceFactory

const unsigned fl7::faces::Face::BUTTON = 0x01000000 | CONTROL [static]

const unsigned fl7::faces::Face::CHECKBOX = 0x02000000 | CONTROL [static]

friend fl7::faces::Face::Collection

const unsigned fl7::faces::Face::COLLECTION = 0x00000002 | FACE [static]

const unsigned fl7::faces::Face::CONTAINER = 0x00000010 | COLLECTION [static]

const unsigned fl7::faces::Face::CONTROL = 0x00000004 | FACE [static]

const unsigned fl7::faces::Face::DIALOG = 0x0f000000 | FRAME [static]

const unsigned fl7::faces::Face::DROPDOWNBOX = 0x0a000000 | FUSION [static]

const unsigned fl7::faces::Face::EDITBOX = 0x03000000 | CONTROL [static]

const unsigned fl7::faces::Face::FACE = 0x00000001 [static]

friend fl7::faces::Face::FaceFriend

const unsigned fl7::faces::Face::FRAME = 0x00000080 | WINDOW [static]

const unsigned fl7::faces::Face::FUSION = 0x00000020 | COLLECTION [static]

const unsigned fl7::faces::Face::GROUPBOX = 0x09000000 | CONTAINER [static]

const unsigned fl7::faces::Face::LABEL = 0x06000000 | STATIC [static]

const unsigned fl7::faces::Face::LISTBOX = 0x0b000000 | FUSION [static]

events::EventHandler<events::EventArgs> fl7::faces::Face::OnDisableEventHandler

Will be called after this face has been disabled.

events::EventHandler<events::EventArgs> fl7::faces::Face::OnDisablePassiveModeEventHandler

Will be called after this face left passive mode.

events::EventHandler<events::EventArgs> fl7::faces::Face::OnEnableEventHandler

Will be called after this face has been enabled.

events::EventHandler<events::EventArgs> fl7::faces::Face::OnEnablePassiveModeEventHandler

Will be called after this face entered passive mode.

events::EventHandler<events::FocusEventArgs> fl7::faces::Face::OnGetFocusEventHandler

Will be called after this face has got the focus.

events::EventHandler<events::EventArgs> fl7::faces::Face::OnHideEventHandler

Will be called after this face has been hidden/set unvisible.

events::EventHandler<events::KeyEventArgs> fl7::faces::Face::OnKeyDownEventHandler

Will be called after a key has been pushed down.

events::EventHandler<events::KeyEventArgs> fl7::faces::Face::OnKeyPressedEventHandler

Will be called after a key has been pressed.

events::EventHandler<events::KeyEventArgs> fl7::faces::Face::OnKeyUpEventHandler

Will be called after a key has been released.

events::EventHandler<events::FocusEventArgs> fl7::faces::Face::OnLoseFocusEventHandler

Will be called after this face has lost the focus.

events::EventHandler<events::MouseButtonEventArgs> fl7::faces::Face::OnMouseButtonDownEventHandler

Will be called after a mouse button has been pushed down.

events::EventHandler<events::MouseButtonEventArgs> fl7::faces::Face::OnMouseButtonPressedEventHandler

Will be called after a mouse button has been pressed.

events::EventHandler<events::MouseButtonEventArgs> fl7::faces::Face::OnMouseButtonUpEventHandler

Will be called after a mouse button has been released.

events::EventHandler<events::MouseEventArgs> fl7::faces::Face::OnMouseEnterEventHandler

Will be called after the mouse enters this face's bounds.

events::EventHandler<events::MouseEventArgs> fl7::faces::Face::OnMouseHoverEventHandler

Will be called after the mouse has been moved inside this face's bounds.

events::EventHandler<events::MouseEventArgs> fl7::faces::Face::OnMouseLeaveEventHandler

Will be called after the mouse leaves this face's bounds.

events::EventHandler<events::MouseEventArgs> fl7::faces::Face::OnMouseMoveEventHandler

Will be called after the mouse has been moved while this face has the focus.

events::EventHandler<events::PositionEventArgs> fl7::faces::Face::OnMoveEventHandler

Will be called after this face has been moved.

events::EventHandler<events::PositionEventArgs> fl7::faces::Face::OnResizeEventHandler

Will be called after this face has been resized.

events::EventHandler<events::EventArgs> fl7::faces::Face::OnShowEventHandler

Will be called after this face has been shown/set visible.

events::EventHandler<events::EventArgs> fl7::faces::Face::OnUpdateDisplayEventHandler

Will be called after the contents of this face have been updated.

const unsigned fl7::faces::Face::PICTUREBOX = 0x08000000 | STATIC [static]

const unsigned fl7::faces::Face::POPUP = 0x0e000000 | WINDOW [static]

const unsigned fl7::faces::Face::PROGRESSBAR = 0x07000000 | STATIC [static]

const unsigned fl7::faces::Face::RADIOBUTTON = 0x04000000 | CONTROL [static]

const unsigned fl7::faces::Face::SCROLLABLE = 0x0c000000 | FUSION [static]

const unsigned fl7::faces::Face::SCROLLBAR = 0x0d000000 | FUSION [static]

friend fl7::faces::Face::Shell

Reimplemented in fl7::faces::Button, fl7::faces::CheckBox, fl7::faces::Container, fl7::faces::EditBox, fl7::faces::RadioButton, fl7::faces::Scrollable, fl7::faces::Slider, and fl7::faces::Window.

const unsigned fl7::faces::Face::SLIDER = 0x05000000 | CONTROL [static]

const unsigned fl7::faces::Face::STATIC = 0x00000008 | FACE [static]

const unsigned fl7::faces::Face::WINDOW = 0x00000040 | FUSION [static]

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

fl7::faces::Face Class Reference

Public Types

Public Member Functions

Public Attributes