Public Types | Public Member Functions | Friends

fl7::Shell Class Reference

#include <Shell.h>

Inheritance diagram for fl7::Shell:
cyber::editor::gui::Shell

List of all members.

Public Types

typedef std::vector
< faces::Window * > 		Windows
typedef std::vector
< faces::Window * >::iterator 		WindowIterator
typedef std::stack
< faces::Dialog * > 		Dialogs
typedef std::stack
< faces::Popup * > 		Popups

Public Member Functions

 Shell (void)
virtual ~Shell (void)
faces::Window * GetActiveWindow () const
faces::Face * GetFocus () const
faces::Face * GetHover () const
int GetZOrder (const faces::Window *const window) const
faces::Face * GetFaceAt (const ml7::Vector2 &absolute_position) const
ml7::Vector2 GetAbsolutePosition (const faces::Face *face) const
ml7::Vector2 GetAbsolutePosition (const faces::Face *face, const ml7::Vector2 &client_position) const
ml7::Vector2 GetClientPosition (const faces::Face *face, const ml7::Vector2 &absolute_position) const
cl7::string_type GetClipboard () const
input::Mouse & GetMouse ()
input::Keyboard & GetKeyboard ()
bool IsCursorVisible () const
const Image & GetCursorImage () const
const Image & GetVoidCursorImage () const
const Config & GetConfig () const
xl7::direct3d::fonts::Font & GetFont ()
const ml7::Vector2 & GetResolution () const
D3DCOLOR GetBaseColor () const
D3DCOLOR GetMixedColor (D3DCOLOR color) const
D3DCOLOR GetMixedColor (const faces::Face *face) const
xl7::direct3d::textures::Texture * GetTexture ()
const
xl7::direct3d::textures::Texture * 		GetTexture () const
const
xl7::directsound::buffers::StaticBuffer * 		GetHoverSound () const
const
xl7::directsound::buffers::StaticBuffer * 		GetFocusSound () const
const
xl7::directsound::buffers::StaticBuffer * 		GetClickSound () const
void SetFocus (faces::Face *face)
bool SetClipboard (const cl7::string_type &clipboard)
void SetResolution (const ml7::Vector2 &resolution)
void SetBaseColor (D3DCOLOR base_color)
void ShowCursor ()
void HideCursor ()
void SetCursorImage (const Image &cursor_image)
Image & UpdateCursorImage ()
void SetVoidCursorImage (const Image &void_cursor_image)
Image & UpdateVoidCursorImage ()
void ActivateWindow (faces::Window *window)
void DeactivateWindow (faces::Window *window)
void OpenFrame (faces::Frame *frame)
void CloseFrame (faces::Frame *frame)
void OpenDialog (faces::Dialog *dialog)
void CloseDialog (faces::Dialog *dialog)
void OpenPopup (faces::Popup *popup)
void ClosePopup (faces::Popup *popup)
bool Init (const Config *config=NULL)
bool Shutdown ()
void Move (float time)
void Draw (float time)
void PlayHoverSound ()
void PlayFocusSound ()
void PlayClickSound ()

Friends

void faces::Face::_Logoff ()

Detailed Description

The class holding the faces and managing events and respective function calls.

Member Typedef Documentation

typedef std::stack<faces::Dialog*> fl7::Shell::Dialogs
typedef std::stack<faces::Popup*> fl7::Shell::Popups
typedef std::vector<faces::Window*>::iterator fl7::Shell::WindowIterator
typedef std::vector<faces::Window*> fl7::Shell::Windows

Constructor & Destructor Documentation

fl7::Shell::Shell ( void   ) 

Default constructor.

fl7::Shell::~Shell ( void   )  [virtual]

Destructor.

Reimplemented in cyber::editor::gui::Shell.

Member Function Documentation

void fl7::Shell::ActivateWindow ( faces::Window *  window  ) 

Activates a given window. If the given window is NULL, the currently active window will be deactivated. If a overlaying dialog is active, this operation has no effect.

void fl7::Shell::CloseDialog ( faces::Dialog *  dialog  ) 

Closes the given dialog. If the given dialog is not the top-most window, this function has no effect.

void fl7::Shell::CloseFrame ( faces::Frame *  frame  ) 

Closes the given frame window.

void fl7::Shell::ClosePopup ( faces::Popup *  popup  ) 

Closes the given popup window. If the given popup is not the top-most window, this function has no effect.

void fl7::Shell::DeactivateWindow ( faces::Window *  window  ) 

Deactivates a given window. If the given window is not currently active or is the top-most dialog, the operation has no effect.

void fl7::Shell::Draw ( float  time  ) 

Draws the windows and other faces as well as the mouse cursor.

ml7::Vector2 fl7::Shell::GetAbsolutePosition ( const faces::Face *  face  )  const

Returns the absolute position of a given face.

ml7::Vector2 fl7::Shell::GetAbsolutePosition ( const faces::Face *  face,
const ml7::Vector2 &  client_position 
) const

Returns the absolute position of a given client position.

faces::Window* fl7::Shell::GetActiveWindow (  )  const [inline]

Returns the active window control (or NULL if no window active).

D3DCOLOR fl7::Shell::GetBaseColor (  )  const [inline]

Returns the base color everything will be mixed up with.

const xl7::directsound::buffers::StaticBuffer* fl7::Shell::GetClickSound (  )  const [inline]

Returns the sound to play on click events.

ml7::Vector2 fl7::Shell::GetClientPosition ( const faces::Face *  face,
const ml7::Vector2 &  absolute_position 
) const

Returns the client position of a given absolute position.

cl7::string_type fl7::Shell::GetClipboard (  )  const

Returns the text in the clipboard to copy and paste.

const Config& fl7::Shell::GetConfig (  )  const [inline]

The configuration structure.

const Image& fl7::Shell::GetCursorImage (  )  const [inline]

Returns the image describing the appearance of the mouse cursor.

faces::Face * fl7::Shell::GetFaceAt ( const ml7::Vector2 &  absolute_position  )  const

Returns the top-most (visible) face at a given absolute position.

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

Returns the face having the focus (or NULL if no face focused).

const xl7::directsound::buffers::StaticBuffer* fl7::Shell::GetFocusSound (  )  const [inline]

Returns the sound to play on focus events.

xl7::direct3d::fonts::Font& fl7::Shell::GetFont (  )  [inline]

Returns the font for displaying text.

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

Returns the face control having the mouse hovering over it (or NULL).

const xl7::directsound::buffers::StaticBuffer* fl7::Shell::GetHoverSound (  )  const [inline]

Returns the sound to play on hover events.

input::Keyboard& fl7::Shell::GetKeyboard (  )  [inline]

Returns the keyboard.

D3DCOLOR fl7::Shell::GetMixedColor ( D3DCOLOR  color  )  const

Returns the given color mixed up with the base color.

D3DCOLOR fl7::Shell::GetMixedColor ( const faces::Face *  face  )  const

Returns the effective color of a given face mixed up with the base color.

input::Mouse& fl7::Shell::GetMouse (  )  [inline]

Returns the mouse.

const ml7::Vector2& fl7::Shell::GetResolution (  )  const [inline]

Returns the imaginary screen resolution.

xl7::direct3d::textures::Texture* fl7::Shell::GetTexture (  )  [inline]

Returns the texture containing the graphics.

const xl7::direct3d::textures::Texture* fl7::Shell::GetTexture (  )  const [inline]

Returns the texture containing the graphics.

const Image& fl7::Shell::GetVoidCursorImage (  )  const [inline]

Returns the image describing the appearance of the mouse cursor while "pointing at nothing".

int fl7::Shell::GetZOrder ( const faces::Window *const   window  )  const

Returns the z-order of a given window (0 => top-most).

void fl7::Shell::HideCursor (  )  [inline]

Makes the mouse cursor invisible.

bool fl7::Shell::Init ( const Config *  config = NULL  ) 

Initializes the shell (loads texture data, creates font, etc.).

bool fl7::Shell::IsCursorVisible (  )  const [inline]

Returns the flag specifying whether to show the mouse cursor or not.

void fl7::Shell::Move ( float  time  ) 

Moves the windows and performs actions and events.

void fl7::Shell::OpenDialog ( faces::Dialog *  dialog  ) 

Opens the given dialog and sets the focus to it to activate it. The dialog can only be deactivated by another dialog overlaying it.

void fl7::Shell::OpenFrame ( faces::Frame *  frame  ) 

Opens the given frame window and sets the focus to it to activate it.

void fl7::Shell::OpenPopup ( faces::Popup *  popup  ) 

Opens the given popup window and sets the focus to it to activate it. If the popup control gets deactivated, it will be closed automatically. (This effect does not take place if another popup emerges.)

void fl7::Shell::PlayClickSound (  ) 

Play the sound for click events.

void fl7::Shell::PlayFocusSound (  ) 

Play the sound for focus events.

void fl7::Shell::PlayHoverSound (  ) 

Play the sound for hover events.

void fl7::Shell::SetBaseColor ( D3DCOLOR  base_color  )  [inline]

Sets the base color everything will be mixed up with.

bool fl7::Shell::SetClipboard ( const cl7::string_type &  clipboard  ) 

Sets the text in the clipboard to copy and paste.

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

Sets the image describing the appearance of the mouse cursor.

void fl7::Shell::SetFocus ( faces::Face *  face  ) 

Lets the given face have the focus. If another face previously has the focus, it loses the focus. If NULL is passed to the function, no face will be focused. The currently active window will eventually be changed as well.

void fl7::Shell::SetResolution ( const ml7::Vector2 &  resolution  )  [inline]

Sets the imaginary screen resolution.

void fl7::Shell::SetVoidCursorImage ( const Image &  void_cursor_image  )  [inline]

Sets the image describing the appearance of the mouse cursor while "pointing at nothing".

void fl7::Shell::ShowCursor (  )  [inline]

Makes the mouse cursor visible.

bool fl7::Shell::Shutdown (  ) 

Shuts down the shell (releases texture etc.).

Image& fl7::Shell::UpdateCursorImage (  )  [inline]

Returns the image describing the appearance of the mouse cursor, so you can update it.

Image& fl7::Shell::UpdateVoidCursorImage (  )  [inline]

Returns the image describing the appearance of the mouse cursor while "pointing at nothing", so you can update it.

Friends And Related Function Documentation

void faces::Face::_Logoff (  )  [friend]
The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Oct 7 2010 13:01:32 for flange77: Cyber E-Razor rockt die Galaxis by  doxygen 1.7.1