From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_button.html | 1796 ++++++++++++++++++++++++++++++++++++ 1 file changed, 1796 insertions(+) create mode 100644 Doc/doxygen/html/class_button.html (limited to 'Doc/doxygen/html/class_button.html') diff --git a/Doc/doxygen/html/class_button.html b/Doc/doxygen/html/class_button.html new file mode 100644 index 0000000..3bf5d71 --- /dev/null +++ b/Doc/doxygen/html/class_button.html @@ -0,0 +1,1796 @@ + + + + + +Starshatter_Open: Button Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
Button Class Reference
+
+
+ +

#include <Button.h>

+
+Inheritance diagram for Button:
+
+
+ + +ActiveWindow +Window +EventTarget + +
+ +

List of all members.

+ + + +

+Public Types

enum  SOUNDS {
+  SND_BUTTON, +SND_CLICK, +SND_SWISH, +SND_CHIRP, +
+  SND_ACCEPT, +SND_REJECT, +SND_CONFIRM, +SND_LIST_SELECT, +
+  SND_LIST_SCROLL, +SND_LIST_DROP, +SND_COMBO_OPEN, +SND_COMBO_CLOSE, +
+  SND_COMBO_HILITE, +SND_COMBO_SELECT, +SND_MENU_OPEN, +SND_MENU_CLOSE, +
+  SND_MENU_SELECT, +SND_MENU_HILITE +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Button (Screen *s, int ax, int ay, int aw, int ah, DWORD id=0)
 Button (ActiveWindow *p, int ax, int ay, int aw, int ah, DWORD id=0)
virtual ~Button ()
virtual void Draw ()
virtual int OnMouseMove (int x, int y)
virtual int OnLButtonDown (int x, int y)
virtual int OnLButtonUp (int x, int y)
virtual int OnClick ()
virtual int OnMouseEnter (int x, int y)
virtual int OnMouseExit (int x, int y)
Color GetActiveColor ()
void SetActiveColor (Color c)
bool GetAnimated ()
void SetAnimated (bool bNewValue)
short GetBevelWidth ()
void SetBevelWidth (short nNewValue)
bool GetBorder ()
void SetBorder (bool bNewValue)
Color GetBorderColor ()
void SetBorderColor (Color c)
short GetButtonState ()
void SetButtonState (short nNewValue)
bool GetDropShadow ()
void SetDropShadow (bool bNewValue)
void GetPicture (Bitmap &img)
void SetPicture (const Bitmap &img)
short GetPictureLocation ()
void SetPictureLocation (short nNewValue)
bool GetSticky ()
void SetSticky (bool bNewValue)
void SetStandardImage (Bitmap *img)
void SetActivatedImage (Bitmap *img)
void SetTransitionImage (Bitmap *img)
- Public Member Functions inherited from ActiveWindow
 ActiveWindow (Screen *s, int ax, int ay, int aw, int ah, DWORD id=0, DWORD style=0, ActiveWindow *parent=0)
virtual ~ActiveWindow ()
int operator== (const ActiveWindow &w) const
virtual void Paint ()
virtual void Show ()
virtual void Hide ()
virtual void MoveTo (const Rect &r)
virtual void UseLayout (const std::vector< DWORD > &min_x, const std::vector< DWORD > &min_y, const std::vector< float > &weight_x, const std::vector< float > &weight_y)
virtual void UseLayout (const std::vector< float > &min_x, const std::vector< float > &min_y, const std::vector< float > &weight_x, const std::vector< float > &weight_y)
virtual void UseLayout (int ncols, int nrows, int *min_x, int *min_y, float *weight_x, float *weight_y)
virtual void DoLayout ()
virtual int OnSelect ()
virtual int OnRButtonDown (int x, int y)
virtual int OnRButtonUp (int x, int y)
virtual int OnMouseWheel (int wheel)
virtual int OnKeyDown (int vk, int flags)
virtual const char * GetDescription () const
virtual int OnDragStart (int x, int y)
virtual int OnDragDrop (int x, int y, ActiveWindow *source)
virtual ActiveWindow * FindControl (int x, int y)
virtual Rect TargetRect () const
virtual ActiveWindow * GetCapture ()
virtual int SetCapture ()
virtual int ReleaseCapture ()
virtual void SetFocus ()
virtual void KillFocus ()
virtual bool HasFocus () const
void SetEnabled (bool e=true)
bool IsEnabled () const
bool IsVisible () const
DWORD GetID () const
void SetStyle (DWORD s)
DWORD GetStyle () const
void SetText (const char *t)
void SetText (const Text &t)
void AddText (const char *t)
void AddText (const Text &t)
const Text & GetText () const
void SetAltText (const char *t)
void SetAltText (const Text &t)
const Text & GetAltText () const
void SetTexture (Bitmap *bmp)
Bitmap * GetTexture ()
void SetMargins (const Insets &m)
Insets & GetMargins ()
void SetTextInsets (const Insets &t)
Insets & GetTextInsets ()
List< ActiveWindow > & GetChildren ()
void SetCellInsets (const Insets &c)
Insets & GetCellInsets ()
void SetCells (int cx, int cy, int cw=1, int ch=1)
void SetCells (const Rect &r)
Rect & GetCells ()
void SetFixedWidth (int w)
int GetFixedWidth () const
void SetFixedHeight (int h)
int GetFixedHeight () const
void SetAlpha (double a)
double GetAlpha () const
void SetBackColor (Color c)
Color GetBackColor () const
void SetBaseColor (Color c)
Color GetBaseColor () const
void SetForeColor (Color c)
Color GetForeColor () const
void SetSingleLine (bool a)
bool GetSingleLine () const
void SetTextAlign (DWORD a)
DWORD GetTextAlign () const
void SetTransparent (bool t)
bool GetTransparent () const
void SetHidePartial (bool a)
bool GetHidePartial () const
void SetTabStop (int n, int x)
int GetTabStop (int n) const
void DrawText (const char *txt, int count, Rect &txt_rect, DWORD flags)
virtual void RegisterClient (int EID, ActiveWindow *client, PFVAWE callback)
virtual void UnregisterClient (int EID, ActiveWindow *client)
virtual void ClientEvent (int EID, int x=0, int y=0)
virtual ActiveWindow * GetForm ()
virtual void SetForm (ActiveWindow *f)
virtual bool IsFormActive () const
virtual bool IsTopMost () const
virtual void SetTopMost (bool t)
virtual ActiveWindow * FindChild (DWORD id)
virtual ActiveWindow * FindChild (int x, int y)
- Public Member Functions inherited from Window
 Window (Screen *s, int ax, int ay, int aw, int ah)
virtual ~Window ()
int operator== (const Window &that) const
Screen * GetScreen () const
const Rect & GetRect () const
int X () const
int Y () const
int Width () const
int Height () const
virtual bool IsShown () const
virtual bool AddView (View *v)
virtual bool DelView (View *v)
Rect ClipRect (const Rect &r)
bool ClipLine (int &x1, int &y1, int &x2, int &y2)
bool ClipLine (double &x1, double &y1, double &x2, double &y2)
void DrawLine (int x1, int y1, int x2, int y2, Color color, int blend=0)
void DrawRect (int x1, int y1, int x2, int y2, Color color, int blend=0)
void DrawRect (const Rect &r, Color color, int blend=0)
void FillRect (int x1, int y1, int x2, int y2, Color color, int blend=0)
void FillRect (const Rect &r, Color color, int alpha=0)
void DrawBitmap (int x1, int y1, int x2, int y2, Bitmap *img, int blend=0)
void FadeBitmap (int x1, int y1, int x2, int y2, Bitmap *img, Color c, int blend)
void ClipBitmap (int x1, int y1, int x2, int y2, Bitmap *img, Color c, int blend, const Rect &clip)
void TileBitmap (int x1, int y1, int x2, int y2, Bitmap *img, int blend=0)
void DrawLines (int nPts, POINT *pts, Color color, int blend=0)
void DrawPoly (int nPts, POINT *pts, Color color, int blend=0)
void FillPoly (int nPts, POINT *pts, Color color, int blend=0)
void DrawEllipse (int x1, int y1, int x2, int y2, Color color, int blend=0)
void FillEllipse (int x1, int y1, int x2, int y2, Color color, int blend=0)
void SetFont (Font *f)
Font * GetFont () const
void Print (int x1, int y1, const char *fmt,...)
- Public Member Functions inherited from EventTarget
virtual ~EventTarget ()
int operator== (const EventTarget &t) const
+ + + + + + + + + + +

+Static Public Member Functions

static void Initialize ()
static void Close ()
static void PlaySound (int n=0)
static void SetVolume (int vol)
- Static Public Member Functions inherited from ActiveWindow
static const char * TYPENAME ()
static void SetSystemFont (Font *f)
static void SetSystemBackColor (Color c)
static void SetSystemForeColor (Color c)
+ + + + + + + + + + + + + + + +

+Protected Member Functions

Rect CalcLabelRect (int img_w, int img_h)
Rect CalcPictureRect ()
void DrawImage (Bitmap *bmp, const Rect &irect)
- Protected Member Functions inherited from ActiveWindow
virtual Color ShadeColor (Color c, double shade)
virtual void AddChild (ActiveWindow *child)
virtual void DrawStyleRect (const Rect &r, int style)
virtual void DrawStyleRect (int x1, int y1, int x2, int y2, int style)
virtual void DrawTabbedText ()
virtual void DrawTextureGrid ()
virtual void CalcGrid ()
- Protected Member Functions inherited from Window
virtual void ScreenToWindow (int &x, int &y)
virtual void ScreenToWindow (Rect &r)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

bool animated
bool drop_shadow
bool sticky
bool border
Color active_color
Color border_color
int captured
int pre_state
short bevel_width
short button_state
short picture_loc
Bitmap picture
Bitmap * standard_image
Bitmap * activated_image
Bitmap * transition_image
- Protected Attributes inherited from ActiveWindow
DWORD id
DWORD style
DWORD text_align
bool single_line
bool focus
bool enabled
bool hide_partial
float alpha
Color back_color
Color base_color
Color fore_color
Text text
Text alt_text
Text desc
Bitmap * texture
Insets margins
Insets text_insets
Insets cell_insets
Rect cells
int fixed_width
int fixed_height
int tab [10]
ActiveWindow * parent
ActiveWindow * form
bool transparent
bool topmost
Layout * layout
List< ActiveWindow > children
List< AWMap > clients
AWEvent event
int rows
int cols
Poly * polys
VertexSet * vset
Material * mtl
- Protected Attributes inherited from Window
Rect rect
Screen * screen
bool shown
Font * font
List< View > view_list
+ + + + + +

+Additional Inherited Members

- Static Protected Attributes inherited from ActiveWindow
static Font * sys_font = 0
static Color sys_back_color = Color(128,128,128)
static Color sys_fore_color = Color( 0, 0, 0)
+

Detailed Description

+
+

Definition at line 24 of file Button.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum Button::SOUNDS
+
+
Enumerator:
+ + + + + + + + + + + + + + + + + + +
SND_BUTTON  +
SND_CLICK  +
SND_SWISH  +
SND_CHIRP  +
SND_ACCEPT  +
SND_REJECT  +
SND_CONFIRM  +
SND_LIST_SELECT  +
SND_LIST_SCROLL  +
SND_LIST_DROP  +
SND_COMBO_OPEN  +
SND_COMBO_CLOSE  +
SND_COMBO_HILITE  +
SND_COMBO_SELECT  +
SND_MENU_OPEN  +
SND_MENU_CLOSE  +
SND_MENU_SELECT  +
SND_MENU_HILITE  +
+
+
+ +

Definition at line 27 of file Button.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Button::Button (Screen * s,
int ax,
int ay,
int aw,
int ah,
DWORD id = 0 
)
+
+ +

Definition at line 48 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Button::Button (ActiveWindow * p,
int ax,
int ay,
int aw,
int ah,
DWORD id = 0 
)
+
+ +

Definition at line 71 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Button::~Button ()
+ 		+virtual
+
+ +

Definition at line 96 of file Button.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Rect Button::CalcLabelRect (int img_w,
int img_h 
)
+ 		+protected
+
+ +

Definition at line 271 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Rect Button::CalcPictureRect ()
+ 		+protected
+
+ +

Definition at line 324 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Button::Close ()
+ 		+static
+
+ +

Definition at line 141 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Button::Draw ()
+ 		+virtual
+
+ +

Reimplemented from ActiveWindow.

+ +

Definition at line 166 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void Button::DrawImage (Bitmap * bmp,
const Rect & irect 
)
+ 		+protected
+
+ +

Definition at line 389 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
Color Button::GetActiveColor ()
+
+ +

Definition at line 609 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
bool Button::GetAnimated ()
+
+ +

Definition at line 619 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
short Button::GetBevelWidth ()
+
+ +

Definition at line 577 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
bool Button::GetBorder ()
+
+ +

Definition at line 589 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
Color Button::GetBorderColor ()
+
+ +

Definition at line 599 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
short Button::GetButtonState ()
+
+ +

Definition at line 641 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
bool Button::GetDropShadow ()
+
+ +

Definition at line 629 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::GetPicture (Bitmap & img)
+
+ +

Definition at line 654 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
short Button::GetPictureLocation ()
+
+ +

Definition at line 665 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + +
bool Button::GetSticky ()
+
+ +

Definition at line 677 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Button::Initialize ()
+ 		+static
+
+ +

Definition at line 111 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Button::OnClick ()
+ 		+virtual
+
+ +

Reimplemented from ActiveWindow.

+ +

Definition at line 523 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int Button::OnLButtonDown (int x,
int y 
)
+ 		+virtual
+
+ +

Reimplemented from ActiveWindow.

+ +

Definition at line 461 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int Button::OnLButtonUp (int x,
int y 
)
+ 		+virtual
+
+ +

Reimplemented from ActiveWindow.

+ +

Definition at line 474 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int Button::OnMouseEnter (int x,
int y 
)
+ 		+virtual
+
+ +

Reimplemented from ActiveWindow.

+ +

Definition at line 535 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int Button::OnMouseExit (int x,
int y 
)
+ 		+virtual
+
+ +

Reimplemented from ActiveWindow.

+ +

Definition at line 549 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int Button::OnMouseMove (int x,
int y 
)
+ 		+virtual
+
+ +

Reimplemented from ActiveWindow.

+ +

Definition at line 403 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Button::PlaySound (int n = 0)
+ 		+static
+
+ +

Definition at line 491 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetActivatedImage (Bitmap * img)
+
+ +

Definition at line 565 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetActiveColor (Color c)
+
+ +

Definition at line 614 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetAnimated (bool bNewValue)
+
+ +

Definition at line 624 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetBevelWidth (short nNewValue)
+
+ +

Definition at line 582 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetBorder (bool bNewValue)
+
+ +

Definition at line 594 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetBorderColor (Color c)
+
+ +

Definition at line 604 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetButtonState (short nNewValue)
+
+ +

Definition at line 646 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetDropShadow (bool bNewValue)
+
+ +

Definition at line 634 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetPicture (const Bitmap & img)
+
+ +

Definition at line 659 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetPictureLocation (short nNewValue)
+
+ +

Definition at line 670 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetStandardImage (Bitmap * img)
+
+ +

Definition at line 559 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetSticky (bool bNewValue)
+
+ +

Definition at line 682 of file Button.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Button::SetTransitionImage (Bitmap * img)
+
+ +

Definition at line 570 of file Button.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Button::SetVolume (int vol)
+ 		+static
+
+ +

Definition at line 485 of file Button.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Bitmap* Button::activated_image
+ 		+protected
+
+ +

Definition at line 116 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color Button::active_color
+ 		+protected
+
+ +

Definition at line 104 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Button::animated
+ 		+protected
+
+ +

Definition at line 99 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
short Button::bevel_width
+ 		+protected
+
+ +

Definition at line 109 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Button::border
+ 		+protected
+
+ +

Definition at line 102 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Color Button::border_color
+ 		+protected
+
+ +

Definition at line 105 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
short Button::button_state
+ 		+protected
+
+ +

Definition at line 110 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Button::captured
+ 		+protected
+
+ +

Definition at line 107 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Button::drop_shadow
+ 		+protected
+
+ +

Definition at line 100 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap Button::picture
+ 		+protected
+
+ +

Definition at line 113 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
short Button::picture_loc
+ 		+protected
+
+ +

Definition at line 112 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Button::pre_state
+ 		+protected
+
+ +

Definition at line 108 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* Button::standard_image
+ 		+protected
+
+ +

Definition at line 115 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Button::sticky
+ 		+protected
+
+ +

Definition at line 101 of file Button.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* Button::transition_image
+ 		+protected
+
+ +

Definition at line 117 of file Button.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1