Adonthell  0.4
text_bubble Class Reference

Displays neat little text speech bubbles. More...

#include <text_bubble.h>

Inheritance diagram for text_bubble:
Collaboration diagram for text_bubble:

Public Member Functions

 text_bubble (const string &text, const string &textcolor, const string &themename, u_int16 len=110)
 Constructor. More...
 
 ~text_bubble ()
 Destructor. More...
 
bool update ()
 Update function. More...
 
u_int16 remaining ()
 Returns the number of game cycles remaining before the death of this bubble. More...
 
- Public Member Functions inherited from win_object< T >
bool draw ()
 Draw process. More...
 
bool update ()
 Update process. More...
 
bool input_update ()
 Input Update process . More...
 
void set_brightness (bool b)
 Set the transluency parameter. More...
 
void set_trans (bool b)
 Set the transluency parameter. More...
 
void pack ()
 
void set_auto_refresh (bool b)
 
- Public Member Functions inherited from win_base
 win_base ()
 Default constructor: More...
 
s_int16 x () const
 Return the relative horizontal position of the win_*. More...
 
s_int16 y () const
 Return the relative vertical position of the win_*. More...
 
s_int16pad_x ()
 Return the pad horizontal position of the win_*. More...
 
s_int16pad_y ()
 Return the pad vertical position of the win_*. More...
 
s_int16 real_x () const
 Return the horizontal position of the win_*. More...
 
s_int16 real_y () const
 Return the vertical position of the win_*. More...
 
virtual void move (s_int16 tx, s_int16 ty)
 Move the win_*. More...
 
virtual void resize (u_int16 tl, u_int16 th)
 Rezise the win_*. More...
 
bool is_visible () const
 Test if win_* is visible. More...
 
void set_visible (const bool b)
 Set the visible parameter. More...
 
bool is_activate () const
 Test if win_* is activated. More...
 
void set_activate (const bool b)
 Set the activate parameter When a win_* is setup on, the keys queue is cleared. More...
 
bool is_focus () const
 Test if win_* has focus on. More...
 
void set_focus (const bool b)
 Set the focus parameter. More...
 
bool is_trans () const
 Test if win_* has focus on. More...
 
bool is_brightness () const
 Test if win_* is in brightness. More...
 
void set_align (const u_int8 a)
 Set alignement of win_*. More...
 
u_int8 align () const
 Return alignment of win_*. More...
 
bool is_can_be_selected () const
 Test if win_* can be selected. More...
 
void set_can_be_selected (const bool b)
 Set the object to be selected A win_obj can be selectable or not when it is inside a win_select. More...
 
void set_manager (win_manager *)
 
- Public Member Functions inherited from win_event
void set_return_code (int rc)
 
void set_signal_connect (const Functor0 &func, u_int8 signal)
 
void set_callback_destroy (const Functor0wRet< bool > &func)
 
void set_callback_quit (const Functor1< int > &func)
 
bool update ()
 
void py_signal_connect (PyObject *pyfunc, int signal, PyObject *args=NULL)
 
- Public Member Functions inherited from win_border
 win_border (win_base *wb)
 
 win_border (win_border &)
 
 win_border (char *rep, const char *size=WIN_BORDER_NORMAL_SIZE)
 
void load (char *, const char *)
 
void update ()
 
void destroy ()
 
void draw (drawing_area *da)
 
void set_visible_border (bool b)
 
void set_brightness_border (bool b)
 
void set_border (win_border &)
 
void set_border (win_theme &wth, u_int8 size=win_border::NORMAL)
 
void set_trans_border (bool b)
 
u_int16 length_border ()
 
u_int16 height_border ()
 
- Public Member Functions inherited from drawing_area
 drawing_area ()
 Default constructor. More...
 
 drawing_area (s_int16 px, s_int16 py, u_int16 pw, u_int16 ph)
 Builds a drawing_area from the parameters. More...
 
s_int16 x () const
 Returns the horizontal position of the drawing_area. More...
 
s_int16 y () const
 Returns the vertical position of the drawing_area. More...
 
u_int16 length () const
 Returns the length of the drawing_area. More...
 
u_int16 height () const
 Returns the height of the drawing_area. More...
 
void move (s_int16 nx, s_int16 ny)
 Move the drawing_area. More...
 
void resize (u_int16 nl, u_int16 nh)
 Resize the drawing_area. More...
 
void assign_drawing_area (const drawing_area *da)
 Assign a drawing_area to this drawing_area. More...
 
drawing_areaassigned_drawing_area () const
 Returns a pointer to the drawing_area assigned to this one. More...
 
void detach_drawing_area ()
 Detach (if needed) the drawing_area which was attached to this one. More...
 
drawing_areaoperator= (SDL_Rect &r)
 Convert an SDL_Rect into a drawing_area. More...
 
SDL_Rect setup_rects () const
 Gets the real parameters of this drawing_area. More...
 
- Public Member Functions inherited from win_background
 win_background (win_base *)
 
 win_background (win_background &)
 
 win_background (char *rep)
 
void load (char *)
 
void update ()
 
void destroy ()
 
void draw (drawing_area *da=NULL)
 
void set_visible_background (bool b)
 
void set_background (win_background &)
 
void set_background (win_theme &wt)
 
void set_brightness_background (bool b)
 
void set_trans_background (bool b)
 

Additional Inherited Members

- Static Public Attributes inherited from win_base
static const u_int8 ALIGN_NONE = 0
 
static const u_int8 ALIGN_LEFT = 1
 
static const u_int8 ALIGN_CENTER = 2
 
static const u_int8 ALIGN_RIGHT = 3
 
- Static Public Attributes inherited from win_event
const static u_int8 ACTIVATE =1
 
const static u_int8 UNACTIVATE = 2
 
const static u_int8 UPDATE = 3
 
const static u_int8 DRAW = 4
 
const static u_int8 DRAW_ON_VISIBLE = 5
 
const static u_int8 ACTIVATE_KEY = 6
 
const static u_int8 SELECT = 7
 
const static u_int8 UNSELECT = 8
 
const static u_int8 KEYBOARD = 9
 
const static u_int8 SCROLL_UP = 10
 
const static u_int8 SCROLL_DOWN = 11
 
const static u_int8 NEXT = 12
 
const static u_int8 PREVIOUS = 13
 
const static u_int8 CLOSE = 14
 
const static u_int8 DESTROY = 15
 
- Static Public Attributes inherited from win_border
const static u_int8 MINI = 0
 
const static u_int8 NORMAL = 1
 
- Protected Member Functions inherited from win_object< T >
void refresh ()
 
- Protected Member Functions inherited from win_base
virtual void update_position ()
 
void update_align ()
 
void set_container (win_container *wc)
 
- Protected Member Functions inherited from win_event
virtual void on_activate ()
 
virtual void on_unactivate ()
 
virtual void on_update ()
 
virtual void on_draw_visible ()
 
virtual void on_draw ()
 
virtual void on_activate_key ()
 
virtual void on_select ()
 
virtual void on_unselect ()
 
virtual void on_up ()
 
virtual void on_down ()
 
virtual void on_next ()
 
virtual void on_previous ()
 
- Protected Attributes inherited from win_object< T >
imageimg_tmp_
 
imageimg_brightness_
 
bool auto_refresh_
 
- Protected Attributes inherited from win_base
s_int16 x_
 
s_int16 y_
 
s_int16 pad_x_
 
s_int16 pad_y_
 
u_int8 align_
 
bool visible_
 
bool focus_
 
bool activate_
 
bool brightness_
 
bool trans_
 
bool can_be_selected_
 
win_containerwb_father_
 
win_managermanager_
 
- Protected Attributes inherited from win_event
vector< py_callback * > py_callbacks
 
Functor0 callback_ [20]
 
Functor0wRet< bool > callback_destroy_
 
Functor1< int > callback_quit_
 
int return_code_
 

Detailed Description

Displays neat little text speech bubbles.

This class makes text bubbles designed to stay visible a short amount of time (just enough to be read).

Definition at line 46 of file text_bubble.h.

Constructor & Destructor Documentation

◆ text_bubble()

text_bubble::text_bubble ( const string &  text,
const string &  textcolor,
const string &  themename,
u_int16  len = 110 
)

Constructor.

Parameters
textText to display in that bubble.
textcolorFont to use with this bubble (directly taken from the win_manager's font collection).
themenameTheme to use with this bubble (directly taken from the win_manager's theme collection).
lenBasic duration (in game cycles) of this bubble. Another amount of time will be added, depending on it's length.

Definition at line 35 of file text_bubble.cc.

◆ ~text_bubble()

text_bubble::~text_bubble ( )

Destructor.

Definition at line 58 of file text_bubble.cc.

Member Function Documentation

◆ update()

bool text_bubble::update ( )
virtual

Update function.

Returns
false if the bubble should be destroyed now, true otherwise.

Reimplemented from win_base.

Definition at line 62 of file text_bubble.cc.

◆ remaining()

u_int16 text_bubble::remaining ( )
inline

Returns the number of game cycles remaining before the death of this bubble.

Returns
Number of game cycles remaining before the death of this bubble.

Definition at line 83 of file text_bubble.h.


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