The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
gui::preview_pane Class Referenceabstract

#include <show_dialog.hpp>

Inheritance diagram for gui::preview_pane:
Inheritance graph

Public Member Functions

 preview_pane (CVideo &video)
 
virtual ~preview_pane ()
 
virtual bool show_above () const
 
virtual bool left_side () const =0
 
virtual void set_selection (int index)=0
 
virtual sdl_handler_vector handler_members ()
 
- Public Member Functions inherited from gui::widget
SDL_Rect const & location () const
 
virtual void set_location (SDL_Rect const &rect)
 
void set_location (int x, int y)
 
void set_width (int w)
 
void set_height (int h)
 
void set_measurements (int w, int h)
 
int width () const
 
int height () const
 
bool focus (const SDL_Event *event)
 
void set_focus (bool focus)
 
virtual void hide (bool value=true)
 
bool hidden () const
 
virtual void enable (bool new_val=true)
 
bool enabled () const
 
void set_clip_rect (const SDL_Rect &rect)
 
void set_volatile (bool val=true)
 
void set_dirty (bool dirty=true)
 
bool dirty () const
 
const std::stringid () const
 
void set_id (const std::string &id)
 
void set_help_string (const std::string &str)
 
void set_tooltip_string (const std::string &str)
 
virtual void process_help_string (int mousex, int mousey)
 
virtual void process_tooltip_string (int mousex, int mousey)
 
- Public Member Functions inherited from events::sdl_handler
virtual void process_event ()
 
virtual bool requires_event_focus (const SDL_Event *=nullptr) const
 
virtual void join ()
 
virtual void join (context &c)
 
virtual void join_same (sdl_handler *parent)
 
virtual void leave ()
 
virtual void join_global ()
 
virtual void leave_global ()
 

Additional Inherited Members

- Protected Member Functions inherited from gui::widget
 widget (widget const &o)
 
 widget (CVideo &video, const bool auto_join=true)
 
virtual ~widget ()
 
void bg_register (SDL_Rect const &rect)
 
void bg_restore () const
 
void bg_restore (SDL_Rect const &rect) const
 
void bg_update ()
 
void bg_cancel ()
 
CVideovideo () const
 
virtual void draw ()
 
virtual void draw_contents ()
 
virtual void update_location (SDL_Rect const &rect)
 
const SDL_Rect * clip_rect () const
 
virtual sdl_handler_vector member_handlers ()
 
virtual void handle_event (SDL_Event const &)
 
virtual void handle_window_event (SDL_Event const &event)
 
bool mouse_locked () const
 
void aquire_mouse_lock ()
 
void free_mouse_lock ()
 
- Protected Member Functions inherited from events::sdl_handler
 sdl_handler (const bool auto_join=true)
 
virtual ~sdl_handler ()
 
- Protected Attributes inherited from gui::widget
bool focus_
 

Detailed Description

Definition at line 175 of file show_dialog.hpp.

Constructor & Destructor Documentation

gui::preview_pane::preview_pane ( CVideo video)
inline

Definition at line 177 of file show_dialog.hpp.

virtual gui::preview_pane::~preview_pane ( )
inlinevirtual

Definition at line 178 of file show_dialog.hpp.

References tooltips::clear_tooltips(), and gui::widget::location().

Member Function Documentation

virtual sdl_handler_vector gui::preview_pane::handler_members ( )
inlinevirtual

Reimplemented from events::sdl_handler.

Reimplemented in dialogs::unit_preview_pane, and mp::wait::leader_preview_pane.

Definition at line 183 of file show_dialog.hpp.

References events::sdl_handler::handler_members().

Referenced by gui::dialog::draw_contents().

virtual bool gui::preview_pane::left_side ( ) const
pure virtual
virtual void gui::preview_pane::set_selection ( int  index)
pure virtual
virtual bool gui::preview_pane::show_above ( ) const
inlinevirtual

Reimplemented in dialogs::unit_preview_pane, and mp::wait::leader_preview_pane.

Definition at line 180 of file show_dialog.hpp.

Referenced by gui::dialog::layout().


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