Logo Search packages:      
Sourcecode: wesnoth-1.9 version File versions  Download package

gui2::tscroll_label Class Reference

#include <scroll_label.hpp>

Inheritance diagram for gui2::tscroll_label:

gui2::tscrollbar_container gui2::tcontainer_ gui2::tcontrol gui2::twidget gui2::tevent_executor gui2::event::tdispatcher

List of all members.


Detailed Description

Label showing a text.

This version shows a scrollbar if the text gets too long and has some scrolling features. In general this widget is slower as the normal label so the normal label should be preferred.

Definition at line 37 of file scroll_label.hpp.


Public Types

enum  tdrawing_action { DRAWN, PARTLY_DRAWN, NOT_DRAWN }
enum  tevent_type { pre = 1, child = 2, post = 4 }
enum  tmouse_behaviour { all, hit, none }
enum  tposition {
  front_pre_child, back_pre_child, front_child, back_child,
  front_post_child, back_post_child
}
enum  tscrollbar_mode { always_visible, always_invisible, auto_visible, auto_visible_first_run }
enum  tvisible { VISIBLE, HIDDEN, INVISIBLE }

Public Member Functions

unsigned add_row (const unsigned count=1)
tgrid::iterator begin ()
bool can_wrap () const
tcanvascanvas (const unsigned index)
std::vector< tcanvas > & canvas ()
void capture_mouse ()
void connect ()
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_notification,
boost::mpl::int_< E >
> >::type 
connect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_keyboard,
boost::mpl::int_< E >
> >::type 
connect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_mouse,
boost::mpl::int_< E >
> >::type 
connect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event, boost::mpl::int_
< E > > >::type 
connect_signal (const tsignal_function &signal, const tposition position=back_child)
const tgridcontent_grid () const
tgridcontent_grid ()
const SDL_Rect & content_visible_area () const
const std::string & definition () const
void demand_reduce_height (const unsigned maximum_height)
void demand_reduce_width (const unsigned maximum_width)
tdialogdialog ()
bool disable_click_dismiss () const
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_notification,
boost::mpl::int_< E >
> >::type 
disconnect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_keyboard,
boost::mpl::int_< E >
> >::type 
disconnect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_mouse,
boost::mpl::int_< E >
> >::type 
disconnect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event, boost::mpl::int_
< E > > >::type 
disconnect_signal (const tsignal_function &signal, const tposition position=back_child)
void draw_background (surface &frame_buffer)
void draw_children (surface &frame_buffer)
void draw_foreground (surface &frame_buffer)
tgrid::iterator end ()
bool execute_hotkey (const hotkey::HOTKEY_COMMAND id)
const twidgetfind (const std::string &id, const bool must_be_active) const
twidgetfind (const std::string &id, const bool must_be_active)
const twidgetfind_at (const tpoint &coordinate, const bool must_be_active) const
twidgetfind_at (const tpoint &coordinate, const bool must_be_active)
bool fire (const tevent event, twidget &target, void *)
bool fire (const tevent event, twidget &target, const SDLKey key, const SDLMod modifier, const Uint16 unicode)
bool fire (const tevent event, twidget &target, const tpoint &coordinate)
bool fire (const tevent event, twidget &target)
bool get_active () const
tpoint get_best_size () const
virtual SDL_Rect get_client_rect () const
unsigned int get_cols () const
tpoint get_config_default_size () const
tpoint get_config_maximum_size () const
tpoint get_config_minimum_size () const
bool get_dirty () const
SDL_Rect get_dirty_rect () const
tdrawing_action get_drawing_action () const
unsigned get_height () const
tscrollbar_mode get_horizontal_scrollbar_mode () const
tmouse_behaviour get_mouse_behaviour () const
tpoint get_origin () const
SDL_Rect get_rect () const
unsigned int get_rows () const
tpoint get_size () const
unsigned get_state () const
PangoAlignment get_text_alignment () const
bool get_use_markup () const
bool get_use_tooltip_on_label_overflow () const
tscrollbar_mode get_vertical_scrollbar_mode () const
tvisible get_visible () const
unsigned get_width () const
const twindowget_window () const
twindowget_window ()
int get_x () const
int get_y () const
tgridgrid ()
const tgridgrid () const
bool has_event (const tevent event, const tevent_type event_type)
bool has_widget (const twidget *widget) const
const t_string & help_message () const
void horizontal_scrollbar_click (twidget *caller)
void horizontal_scrollbar_moved ()
const std::string & id () const
void init_grid (const boost::intrusive_ptr< tbuilder_grid > &grid_builder)
const t_string & label () const
void layout_init (const bool full_initialization)
void load_config ()
twidgetparent ()
void place (const tpoint &origin, const tpoint &size)
void populate_dirty_list (twindow &caller, std::vector< twidget * > &call_stack)
void reduce_height (const unsigned maximum_height)
void reduce_width (const unsigned maximum_width)
void register_hotkey (const hotkey::HOTKEY_COMMAND id, const thotkey_function &function)
void release_mouse ()
void request_reduce_height (const unsigned maximum_height)
void request_reduce_width (const unsigned maximum_width)
void scroll_horizontal_scrollbar (const tscrollbar_::tscroll scroll)
void scroll_vertical_scrollbar (const tscrollbar_::tscroll scroll)
void set_active (const bool active)
void set_child (twidget *widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)
void set_cols (const unsigned cols)
void set_column_grow_factor (const unsigned column, const unsigned factor)
void set_debug_border_color (const unsigned debug_border_color)
void set_debug_border_mode (const unsigned debug_border_mode)
void set_definition (const std::string &definition)
void set_dirty (const bool dirty=true)
void set_help_message (const t_string &help_message)
void set_horizontal_scrollbar_mode (const tscrollbar_mode scrollbar_mode)
void set_id (const std::string &id)
void set_label (const t_string &label)
void set_linked_group (const std::string &linked_group)
virtual void set_members (const string_map &data)
void set_mouse_behaviour (const tmouse_behaviour mouse_behaviour)
void set_origin (const tpoint &origin)
void set_parent (twidget *parent)
void set_row_grow_factor (const unsigned row, const unsigned factor)
void set_rows (const unsigned rows)
void set_rows_cols (const unsigned rows, const unsigned cols)
void set_self_active (const bool active)
virtual void set_size (const tpoint &size)
void set_text_alignment (const PangoAlignment text_alignment)
void set_tooltip (const t_string &tooltip)
void set_use_markup (bool use_markup)
void set_use_tooltip_on_label_overflow (const bool use_tooltip=true)
void set_vertical_scrollbar_mode (const tscrollbar_mode scrollbar_mode)
void set_visible (const tvisible visible)
void set_visible_area (const SDL_Rect &area)
void set_wants_mouse_hover (const bool hover=true)
void set_wants_mouse_left_double_click (const bool click=true)
void set_wants_mouse_middle_double_click (const bool click=true)
tevent_executorset_wants_mouse_right_double_click (const bool click=true)
void set_x (const int x)
void set_y (const int y)
const t_string & tooltip () const
void vertical_scrollbar_click (twidget *caller)
void vertical_scrollbar_moved ()
bool wants_mouse_hover () const
bool wants_mouse_left_double_click () const
bool wants_mouse_middle_double_click () const
bool wants_mouse_right_double_click () const

Protected Member Functions

tresolution_definition_const_ptr config () const
tresolution_definition_ptr config ()
bool content_resize_request (const int width_modification, const int height_modification)
bool content_resize_request (const bool force_sizing=false)
int get_text_maximum_height () const
int get_text_maximum_width () const
virtual void handle_key_down_arrow (SDLMod modifier, bool &handled)
virtual void handle_key_end (SDLMod modifier, bool &handled)
virtual void handle_key_home (SDLMod modifier, bool &handled)
virtual void handle_key_left_arrow (SDLMod modifier, bool &handled)
virtual void handle_key_page_down (SDLMod modifier, bool &handled)
virtual void handle_key_page_up (SDLMod modifier, bool &handled)
virtual void handle_key_right_arrow (SDLMod modifier, bool &handled)
virtual void handle_key_up_arrow (SDLMod modifier, bool &handled)
void impl_draw_background (surface &frame_buffer)
void impl_draw_foreground (surface &)
const tpointlayout_size () const
void set_config (tresolution_definition_ptr config)
void set_layout_size (const tpoint &size)
void set_scrollbar_button_status ()
void show_content_rect (const SDL_Rect &rect)
virtual void update_canvas ()

Private Types

enum  tstate { ENABLED, DISABLED, COUNT }

Private Member Functions

void finalize_subclass ()
const std::string & get_control_type () const
void signal_handler_left_button_down (const event::tevent event)

Private Attributes

tstate state_

Friends

struct implementation::tbuilder_scroll_label
struct implementation::tbuilder_scrollbar_panel

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

Generated by  Doxygen 1.6.0   Back to index