IMS2  Pre-Alpha
An Orbiter add-on to allow on-runtime construction of spacecraft from predefined modules
GUI_StaticButton Class Reference

A button with a static background from a texture surface. More...

Inheritance diagram for GUI_StaticButton:
GUI_BaseElement

Public Member Functions

 GUI_StaticButton (RECT _rect, int srcx, int srcy, SURFHANDLE _src, int _id)
 
- Public Member Functions inherited from GUI_BaseElement
 GUI_BaseElement (RECT _rect, int _id, GUI_ElementStyle *_style)
 
virtual void Draw (SURFHANDLE _tgt, RECT &drawablerect, int xoffset=0, int yoffset=0)
 Draws the element and its children to a SURFHANDLE. More...
 
virtual bool Update ()
 Checks if this element or any of its children need to be redrawn. More...
 
int ProcessMouse (GUI_MOUSE_EVENT _event, int _x, int _y)
 Checks if the element or any of its children have been clicked. More...
 
virtual void AddChild (GUI_BaseElement *child)
 Adds a child to this element. More...
 
void GetRect (RECT &mRect)
 Copies the elements rect to the passed reference. More...
 
GUI_ElementStyleGetStyle ()
 
int GetWidth ()
 
int GetHeight ()
 
int GetId ()
 
GUI_ELEMENT_TYPE GetType ()
 
virtual void SetVisible (bool _visible)
 Sets if the elements and its children are drawn or not. More...
 
bool GetVisible ()
 
virtual void SetFixed (bool fixed)
 
bool GetFixed ()
 
virtual void SetNoBlit (bool noblit)
 
bool GetNoBlit ()
 
SURFHANDLE GetSurface ()
 
void AddPlugin (GUIplugin *plugin)
 Adds a GUIplugin as a child of this element. More...
 
void RemovePlugin (GUIplugin *plugin)
 Unplugs a plugin from this element. More...
 

Private Member Functions

void DrawMe (SURFHANDLE _tgt, int xoffset, int yoffset, RECT &drawablerect)
 Draws this element. More...
 
bool ProcessMe (GUI_MOUSE_EVENT _event, int _x, int _y)
 Processes events for this element. More...
 

Private Attributes

RECT srcRect
 Stores the rectangle of the buttons bitmap on the source surface.
 

Additional Inherited Members

- Protected Member Functions inherited from GUI_BaseElement
virtual void DrawChildren (SURFHANDLE _tgt, RECT &drawablerect, int xoffset=0, int yoffset=0)
 Draws all direct children of this element, and tells them to draw theirs. More...
 
virtual int ProcessChildren (GUI_MOUSE_EVENT _event, int _x, int _y)
 Forwards event to its children. More...
 
virtual bool updateMe ()
 used for checking whether this element needs a redraw although it didn't have any user input More...
 
virtual bool updateChildren ()
 checks if any of the children need a redraw More...
 
void calculateBlitData (int xoffset, int yoffset, RECT &drawablerect, BLITDATA &OUT_blitdata)
 Calculates the positional and dimensional data needed for blitting, both for source as well as target surface. More...
 
void calculateMyDrawableRect (RECT &drawablerect_parent, int xoffset, int yoffset, RECT &OUT_mydrawablerect)
 calculates the real drawable rect of this element considering the drawable rect of the parent. More...
 
- Protected Attributes inherited from GUI_BaseElement
GUI_ELEMENT_TYPE type
 The type of this element.
 
RECT rect
 Rect the element should draw on, relative to parent.
 
int width
 The width of the element.
 
int height
 The height of the element.
 
int id
 The locally unique identifier of the element.
 
SURFHANDLE src = NULL
 Source surface to draw the element on. When the element is drawn on the panel, it will be blitted from this surface.
 
bool noBlitting = false
 Some elements might not have to blit themselves because they are static part of the background. This is not the same as !visible, as the element still processes events and still draws children, it just doesn't draw itself.
 
vector< GUI_BaseElement * > children
 List containing all direct children of this element.
 
vector< GUIplugin * > plugins
 List containing all GUIplugins currently pluged into this element.
 
GUI_fontfont
 The font used by this element.
 
GUI_ElementStylestyle
 The style used by this element.
 
bool visible
 Whether the element is visible or not (if false, element and any of its children will neither draw nor process events)
 
bool isfixed = false
 Whether the element retains a fixed position in a scrolling frame.
 

Detailed Description

A button with a static background from a texture surface.

Acts like a button, but draws what's in the defined place on the defined surface. No labeling or styling possible.

Note
More or less deprecated. You should have a really good reason to use this!

Constructor & Destructor Documentation

GUI_StaticButton::GUI_StaticButton ( RECT  _rect,
int  srcx,
int  srcy,
SURFHANDLE  _src,
int  _id 
)
Parameters
_rectParent-relative rectangle of this element
srcxX coordinate of the bitmap on the source surface
srcyY coordinate of the bitmap on the source surface
_srcThe source surface to take the bitmap from
_idLocally unique identifier for this element

Member Function Documentation

void GUI_StaticButton::DrawMe ( SURFHANDLE  _tgt,
int  xoffset,
int  yoffset,
RECT &  drawablerect 
)
privatevirtual

Draws this element.

Separated from DrawChildren so it can be freely overloaded

Parameters
_tgtThe target surface to draw to
xoffsetThe offset between this element rects left edge and the left panel edge, in pixel
yoffsetThe offset between this element rects top edge and the top panel edge, in pixel
drawablerectThe total drawable rect of this element. Serves as clipping rect.

Reimplemented from GUI_BaseElement.

bool GUI_StaticButton::ProcessMe ( GUI_MOUSE_EVENT  _event,
int  _x,
int  _y 
)
privatevirtual

Processes events for this element.

Separated from ProcessChildren() so either can be freely overloaded without the other

Parameters
_eventThe mouse event that triggered the call
_xthe x coordinate of the click, relative to the panel
_ythe y coordinate of the click, relative to the panel
Returns
True if this element has consumed the event

Reimplemented from GUI_BaseElement.


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