Dragonfly 4.20
A text-based game engine
Public Member Functions | Private Attributes | List of all members
df::TextBox Class Reference
Inheritance diagram for df::TextBox:
Inheritance graph

Public Member Functions

void setText (std::string new_text)
 
void addText (std::string new_text)
 
std::string getText () const
 
void clearText ()
 
Vector getSize () const
 
void setSize (df::Vector new_size)
 
bool getPadding () const
 
void setPadding (bool new_padding)
 
bool getWordWrap () const
 
void setWordWrap (bool new_word_wrap)
 
virtual int draw () override
 
virtual int serialize (std::stringstream *p_ss, unsigned int attr=0) override
 
virtual int deserialize (std::stringstream *p_ss, unsigned int *p_a=NULL) override
 
- Public Member Functions inherited from df::ViewObject
 ViewObject ()
 
virtual int draw () override
 
virtual int eventHandler (const Event *p_e) override
 
virtual void setLocation (ViewObjectLocation new_location)
 
ViewObjectLocation getLocation () const
 
virtual void setDrawValue (bool new_draw_value=true)
 
bool getDrawValue () const
 
virtual void setValue (int new_value)
 
int getValue () const
 
virtual void setBorder (bool new_border)
 
bool getBorder () const
 
virtual void setColor (Color new_color)
 
Color getColor () const
 
virtual void setViewString (std::string new_view_string)
 
std::string getViewString () const
 
virtual int setPosition (Vector new_pos) override
 
virtual int serialize (std::stringstream *p_ss, unsigned int attr=0) override
 
virtual int deserialize (std::stringstream *p_ss, unsigned int *p_a=NULL) override
 
std::string toString () const
 
bool operator== (const ViewObject &vo)
 
bool operator!= (const ViewObject &vo)
 
- Public Member Functions inherited from df::Object
 Object ()
 
virtual ~Object ()
 
void setId (int new_id)
 
int getId () const
 
virtual void setType (std::string new_type)
 
std::string getType () const
 
virtual int setPosition (Vector new_position)
 
Vector getPosition () const
 
virtual int eventHandler (const Event *p_event)
 
bool isSolid () const
 
virtual int setSolidness (Solidness new_solid)
 
Solidness getSolidness () const
 
void setNoSoft (bool new_no_soft=true)
 
bool getNoSoft () const
 
virtual void setAvoidCollisions (bool new_avoid_collisions=true)
 
bool getAvoidCollisions () const
 
virtual int setAltitude (int new_altitude)
 
int getAltitude () const
 
void setSpeed (float speed)
 
float getSpeed () const
 
virtual void setDirection (Vector new_direction)
 
Vector getDirection () const
 
virtual void setVelocity (Vector velocity)
 
Vector getVelocity () const
 
virtual 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 new_position)
 
void doPathFollowing ()
 
int setVisible (bool new_visible=true)
 
virtual bool isVisible () const
 
virtual int setActive (bool new_active=true)
 
bool isActive () const
 
virtual void setBox (Box new_box)
 
Box getBox () const
 
int registerInterest (std::string event_type)
 
int unregisterInterest (std::string event_type)
 
int getEventCount () const
 
virtual int setSprite (std::string sprite_label)
 
virtual void setAnimation (Animation new_animation, bool set_box=true)
 
Animation getAnimation () const
 
virtual int draw ()
 
virtual int serialize (std::stringstream *p_ss, unsigned int attr=0)
 
virtual int deserialize (std::stringstream *p_ss, unsigned int *p_a=NULL)
 
bool isModified (enum ObjectAttribute attribute) const
 
bool isModified () const
 
virtual void setModified (unsigned int new_modified)
 
virtual unsigned int getModified () const
 
virtual void setShape (Shape new_shape)
 
Shape getShape () const
 
virtual void setFollowPath (bool new_follow_path=true)
 
bool getFollowPath () const
 
void setPath (Path new_path)
 
Path getPath () const
 
PathFindgetPathFind ()
 
std::string toString () const
 
bool operator== (const Object &o)
 
bool operator!= (const Object &o)
 

Private Attributes

std::string m_text
 
Vector m_size
 
bool m_padding
 
bool m_word_wrap
 

Additional Inherited Members

- Static Public Attributes inherited from df::Object
static int max_id
 

Member Function Documentation

◆ addText()

void df::TextBox::addText ( std::string  new_text)

Append text, adding to any current text.

◆ clearText()

void df::TextBox::clearText ( )

Remove all text.

◆ deserialize()

virtual int df::TextBox::deserialize ( std::stringstream *  p_ss,
unsigned int *  p_a = NULL 
)
overridevirtual

Deserialize stream to attributes and apply.

p_ss - incoming stream to deserialize. p_a - outgoing bitmask of attributes modified (NULL means no outgoing). Return 0 if ok, else -1.

Reimplemented from df::ViewObject.

◆ draw()

virtual int df::TextBox::draw ( )
overridevirtual

Draw box and text.

Reimplemented from df::ViewObject.

◆ getPadding()

bool df::TextBox::getPadding ( ) const

Get padding.

◆ getSize()

Vector df::TextBox::getSize ( ) const

Get size.

◆ getText()

std::string df::TextBox::getText ( ) const

Get text.

◆ getWordWrap()

bool df::TextBox::getWordWrap ( ) const

Get word wrap.

◆ serialize()

virtual int df::TextBox::serialize ( std::stringstream *  p_ss,
unsigned int  attr = 0 
)
overridevirtual

Serialize attributes to stream.

Can specify individual attribute(s) to force (modified or not). Default is only modified attributes. Clears modified bits for attributes serialized. Return 0 if ok, else -1.

Reimplemented from df::ViewObject.

◆ setPadding()

void df::TextBox::setPadding ( bool  new_padding)

Set padding.

◆ setSize()

void df::TextBox::setSize ( df::Vector  new_size)

Set size.

◆ setText()

void df::TextBox::setText ( std::string  new_text)

Set text, overwritting any current text.

◆ setWordWrap()

void df::TextBox::setWordWrap ( bool  new_word_wrap)

Set word wrap.

Member Data Documentation

◆ m_padding

bool df::TextBox::m_padding
private

True to pad rows from side bars.

◆ m_size

Vector df::TextBox::m_size
private

Width (x), height (y), in spaces.

◆ m_text

std::string df::TextBox::m_text
private

Text in box.

◆ m_word_wrap

bool df::TextBox::m_word_wrap
private

True to wrap lines at spaces.