MityDSP Documentation Index
Public Member Functions
MityDSP::tcGuiLamp Class Reference

#include <gui_lamp.h>

Inheritance diagram for MityDSP::tcGuiLamp:
MityDSP::tcGuiObject

List of all members.

Public Member Functions

 tcGuiLamp (const char *name, tcBench *bench, int idd)
 ~tcGuiLamp ()
virtual bool ParseXML (TiXmlElement *ahDom)
void create ()
void set_state (LAMPSTATE state)
LAMPSTATE get_state ()
void draw (tcGuiDspDisplay &pd)
void animate ()
void blink (LAMPSTATE base_state, LAMPSTATE blink_state, int milliseconds=300)
- Public Member Functions inherited from MityDSP::tcGuiObject
 tcGuiObject (const char *name, tcBench *bench, int idd, uint32 type)
virtual ~tcGuiObject ()
const char * name ()
const GSTRINGgname ()
uint32 type ()
int idd ()
const char * get_text ()
bool is_visible ()
int get_x_pos ()
int get_y_pos ()
int get_height ()
int get_width ()
void get_rect (tcRect &rect)
int get_type ()
virtual tcGuiObjectget_parent_obj ()
virtual void show (bool show=true)
virtual void hide ()
virtual void set_text (const char *text)
virtual void set_x_pos (int x)
virtual void set_y_pos (int y)
virtual void set_height (int h)
virtual void set_width (int w)
void set_image (tcGuiImage *image)
virtual void set_text_x_pos (int x)
virtual void set_text_y_pos (int y)
void set_text_font (tcDspFont *font)
void set_text_font (const char *font_name)
void set_text_align (int align)
void set_text_color (tsRgb color)
void set_text_vertical (bool vert)
void set_text_wrap (bool wrap)
void set_fg_color (tsRgb color)
void set_bg_color (tsRgb color)
void set_user_id (int id)
virtual void set_animate (bool animate)
void set_user_ptr (void *ptr)
int get_user_id ()
tsRgb get_fg_color ()
tsRgb get_bg_color ()
tsRgb get_text_color ()
virtual bool is_point_in (int x, int y)
virtual bool is_rect_overlapped (tcRect &rect)
virtual bool lbutton_down (int x, int y)
virtual void lbutton_up (int x, int y)
virtual void mouse_move (int x, int y, int flags)
virtual bool does_l_mouse ()
void invalidate (tcRect *bckgrnd_redraw=NULL)

Additional Inherited Members

- Public Types inherited from MityDSP::tcGuiObject
enum  teAlignment {
  eeAlignLeft = 0x0000, eeAlignHCenter = 0x0001, eeAlignRight = 0x0002, eeAlignHMask = 0x0003,
  eeAlignTop = 0x0000, eeAlignVCenter = 0x0010, eeAlignBottom = 0x0020, eeAlignVMask = 0x0030,
  eeAlignCenter = eeAlignHCenter|eeAlignVCenter, eeAlignTopLeft = eeAlignTop|eeAlignLeft
}
- Protected Member Functions inherited from MityDSP::tcGuiObject
virtual void calculate_text_rect (int alignment)
virtual void draw_text (tcGuiDspDisplay &pd, int alignment, int dip=0, float opacity=1.0F)
- Protected Attributes inherited from MityDSP::tcGuiObject
bool m_created
 true when XML file parsing is complete and object has been initialized
bool m_visible
 true when object is potentially visible on the full screen
uint32 m_type
tcBenchm_bench
 pointer to the tcGuiBench (widget manager) object
bool m_animate
 true if this widget will perform animation
GSTRING m_name
 name of the widget
int m_idd
 unique ID number of the widget
int m_x_pos
 screen x position of the widget
int m_y_pos
 screen y position of the widget
int m_height
 widget height
int m_width
 widget widget
tcRect m_obj_rect
 bounding rectangle of widget (screen coordinates) (may not include all text)
tcRect m_text_rect
 bounding rectangle text for widget (screen coordinates)
int m_lcapture_x
int m_lcapture_y
int m_rcapture_x
int m_rcapture_y
tsRgb m_fg_color
 foregroun color to use when rendering tcGuiObject
tsRgb m_bg_color
 background color to use when rendering tcGuiObject
tsRgb m_text_color
 color to use when rendering tcGuiObject text
tcDspFont * m_font
 font to use when rendering tcGuiObject text
GSTRING m_text
 base tcGuiObject class text data
int m_text_x_pos
 reference screen x position of object text
int m_text_y_pos
 reference screen y position of object text
int m_text_align
 alignment flags used for text rendering
bool m_text_vertical
bool m_text_wrap
 true if this text string should be wrapped to available space when drawn
int m_user_id
void * m_user_ptr
tcGuiImagem_image
 pointer to optional background image

Constructor & Destructor Documentation

tcGuiLamp::tcGuiLamp ( const char *  name,
tcBench bench,
int  idd 
)
tcGuiLamp::~tcGuiLamp ( )

Member Function Documentation

bool tcGuiLamp::ParseXML ( TiXmlElement *  apElement)
virtual

Parse common XML elements from the DOM.

Reimplemented from MityDSP::tcGuiObject.

void tcGuiLamp::create ( )
virtual

Reimplemented from MityDSP::tcGuiObject.

void tcGuiLamp::set_state ( LAMPSTATE  state)
LAMPSTATE MityDSP::tcGuiLamp::get_state ( )
inline
void tcGuiLamp::draw ( tcGuiDspDisplay pd)
virtual

Reimplemented from MityDSP::tcGuiObject.

void tcGuiLamp::animate ( )
virtual

Handle display widget animation (scrolling, etc.). This method should be called periodically from the top level framework when the widget is visible.

Reimplemented from MityDSP::tcGuiObject.

void tcGuiLamp::blink ( LAMPSTATE  base_state,
LAMPSTATE  blink_state,
int  milliseconds = 300 
)

  
Generated on Mon Apr 22 2013 11:33:50 for MityDSP Skinnable Graphics User Interface (GGUI) by  Doxygen Version 1.8.1.1
Copyright © 2009, Critical Link LLC, All rights reserved.