Dragonfly  4.4
A text-based game engine
Public Member Functions | Private Attributes | List of all members
df::Button Class Referenceabstract
Inheritance diagram for df::Button:
Inheritance graph
Collaboration diagram for df::Button:
Collaboration graph

Public Member Functions

int eventHandler (const Event *p_e)
void setHighlightColor (Color new_highlight_color)
Color getHighlightColor () const
void setDefaultColor (Color new_default_color)
Color getDefaultColor () const
bool mouseOverButton (const EventMouse *p_e) const
virtual void callback ()=0
virtual std::string serialize (bool all=false)
virtual int deserialize (std::string s)
virtual bool isModified (enum ButtonAttribute attribute) const
virtual bool isModified () const
- Public Member Functions inherited from df::ViewObject
 ViewObject ()
virtual void draw ()
void setLocation (ViewObjectLocation new_location)
ViewObjectLocation getLocation () const
void setDrawValue (bool new_draw_value=true)
bool getDrawValue () const
void setValue (int new_value)
int getValue () const
void setBorder (bool new_border)
bool getBorder () const
void setColor (Color new_color)
Color getColor () const
void setViewString (std::string new_view_string)
std::string getViewString () const
void setPosition (Vector new_pos)
virtual bool isModified (enum ViewObjectAttribute attribute) const
- Public Member Functions inherited from df::Object
 Object ()
virtual ~Object ()
void setId (int new_id)
int getId () const
void setType (std::string new_type)
std::string getType () const
Vector getPosition () const
bool isSolid () const
int setSolidness (Solidness new_solid)
Solidness getSolidness () const
void setNoSoft (bool new_no_soft=true)
bool getNoSoft () const
void setAvoidCollisions (bool new_avoid_collisions=true)
bool getAvoidCollisions () const
int setAltitude (int new_altitude)
int getAltitude () const
void setSpeed (float speed)
float getSpeed () const
void setDirection (Vector new_direction)
Vector getDirection () const
void setVelocity (Vector velocity)
Vector getVelocity () const
void setAcceleration (Vector new_acceleration)
Vector getAcceleration () const
void accelerate ()
Vector predictPosition ()
void pathTo (Vector position)
void pathTo (Object *p_o_target)
void moveTo (Vector position)
void doPathFollowing ()
int setVisible (bool visible=true)
bool isVisible () const
int setActive (bool active=true)
bool isActive () const
void setBox (Box new_box)
Box getBox () const
int registerInterest (std::string event_type)
int unregisterInterest (std::string event_type)
void setSpriteName (std::string new_name)
std::string getSpriteName () const
void setSprite (Sprite *p_new_sprite, bool set_box=true)
SpritegetSprite () const
void setCentered (bool centered=true)
bool isCentered () const
void setTransparency (char transparent=' ')
char getTransparency () const
void setSpriteIndex (int new_sprite_index)
int getSpriteIndex () const
void setSpriteSlowdown (int new_sprite_slowdown)
int getSpriteSlowdown () const
void setSpriteSlowdownCount (int new_sprite_slowdown_count)
int getSpriteSlowdownCount () const
virtual bool isModified (enum ObjectAttribute attribute) const
void setShape (Shape new_shape)
Shape getShape () const
void setFollowPath (bool new_follow_path=true)
bool getFollowPath () const
void setPath (Path new_path)
Path getPath () const
PathFindgetPathFind ()

Private Attributes

Color m_highlight_color
Color m_default_color
bool m_bmodified [BATTR_COUNT]

Member Function Documentation

virtual void df::Button::callback ( )
pure virtual

Called when Button clicked.

Must be defined by derived class.

virtual int df::Button::deserialize ( std::string  s)

Deserialize string to become attributes.

Rerturn 0 if no errors, else -1.

Reimplemented from df::ViewObject.

int df::Button::eventHandler ( const Event p_e)

Handle "mouse" events.

Return 0 if ignored, else 1.

Reimplemented from df::ViewObject.

Color df::Button::getDefaultColor ( ) const

Get color of Button.

Color df::Button::getHighlightColor ( ) const

Get highlight (when mouse over) color for Button.

virtual bool df::Button::isModified ( enum ButtonAttribute  attribute) const

Return true if attribute modified since last serialize.

virtual bool df::Button::isModified ( ) const

Return true if any attribute modified since last serialize.

Reimplemented from df::ViewObject.

bool df::Button::mouseOverButton ( const EventMouse p_e) const

Return true if mouse over Button, else false.

virtual std::string df::Button::serialize ( bool  all = false)

Serialize Button attributes to single string.

Only modified attributes (unless all is true).

Reimplemented from df::ViewObject.

void df::Button::setDefaultColor ( Color  new_default_color)

Set color of Button.

void df::Button::setHighlightColor ( Color  new_highlight_color)

Set highlight (when mouse over) color for Button.

Member Data Documentation

bool df::Button::m_bmodified[BATTR_COUNT]

Modified attribute since serialize().

Color df::Button::m_default_color

Color when not highlighted.

Color df::Button::m_highlight_color

Color when highlighted.