The Battle for Wesnoth  1.15.1+dev
Classes | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
gui::dialog_frame Class Reference

#include <show_dialog.hpp>

Inheritance diagram for gui::dialog_frame:
Inheritance graph

Classes

struct  dimension_measurements
 
class  style
 

Public Member Functions

 dialog_frame (CVideo &video, const std::string &title="", const style &dialog_style=default_style, bool auto_restore=true, std::vector< button *> *buttons=nullptr, button *help_button=nullptr)
 
 ~dialog_frame ()
 
dimension_measurements layout (int x, int y, int w, int h)
 
dimension_measurements layout (const SDL_Rect &frame_area)
 
void set_layout (dimension_measurements &new_dim)
 
dimension_measurements get_layout () const
 
int top_padding () const
 
int bottom_padding () const
 
void draw ()
 
void draw_border ()
 
void draw_background ()
 
SDL_Rect draw_title (CVideo *video)
 
void set_dirty (bool dirty=true)
 
virtual void handle_event (const SDL_Event &)
 
void handle_window_event (const SDL_Event &event)
 
- Public Member Functions inherited from events::sdl_handler
virtual void process_event ()
 
virtual void volatile_draw ()
 
virtual void volatile_undraw ()
 
virtual bool requires_event_focus (const SDL_Event *=nullptr) const
 
virtual void process_help_string (int, int)
 
virtual void process_tooltip_string (int, int)
 
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 ()
 
virtual bool has_joined ()
 
virtual bool has_joined_global ()
 
sdl_handleroperator= (sdl_handler &&)=delete
 Moving would require two instances' context membership to be handled, it's simpler to delete these and require the two instances to be separately constructed / destructed. More...
 
 sdl_handler (sdl_handler &&)=delete
 

Static Public Attributes

static const int title_border_w = 10
 
static const int title_border_h = 5
 
static const style default_style
 
static const style message_style
 
static const style preview_style
 
static const style titlescreen_style
 

Private Member Functions

void clear_background ()
 

Private Attributes

std::string title_
 
CVideovideo_
 
const styledialog_style_
 
std::vector< button * > * buttons_
 
buttonhelp_button_
 
surface_restorerrestorer_
 
bool auto_restore_
 
dimension_measurements dim_
 
surface top_
 
surface bot_
 
surface left_
 
surface right_
 
surface top_left_
 
surface bot_left_
 
surface top_right_
 
surface bot_right_
 
surface bg_
 
bool have_border_
 
bool dirty_
 

Additional Inherited Members

- Protected Member Functions inherited from video2::draw_layering
 draw_layering (const bool auto_join=true)
 
virtual ~draw_layering ()
 
- Protected Member Functions inherited from events::sdl_handler
 sdl_handler (const bool auto_join=true)
 
 sdl_handler (const sdl_handler &)
 
sdl_handleroperator= (const sdl_handler &)
 
virtual ~sdl_handler ()
 
virtual std::vector< sdl_handler * > handler_members ()
 

Detailed Description

Definition at line 51 of file show_dialog.hpp.

Constructor & Destructor Documentation

◆ dialog_frame()

gui::dialog_frame::dialog_frame ( CVideo video,
const std::string &  title = "",
const style dialog_style = default_style,
bool  auto_restore = true,
std::vector< button *> *  buttons = nullptr,
button help_button = nullptr 
)

Definition at line 81 of file show_dialog.cpp.

◆ ~dialog_frame()

gui::dialog_frame::~dialog_frame ( )

Definition at line 106 of file show_dialog.cpp.

References restorer_.

Member Function Documentation

◆ bottom_padding()

int gui::dialog_frame::bottom_padding ( ) const

Definition at line 164 of file show_dialog.cpp.

References b, bot_, buttons_, gui::ButtonVPadding, and have_border_.

◆ clear_background()

void gui::dialog_frame::clear_background ( )
private

Definition at line 289 of file show_dialog.cpp.

References restorer_.

Referenced by draw_background().

◆ draw()

void gui::dialog_frame::draw ( )
virtual

◆ draw_background()

void gui::dialog_frame::draw_background ( )

◆ draw_border()

void gui::dialog_frame::draw_border ( )

◆ draw_title()

SDL_Rect gui::dialog_frame::draw_title ( CVideo video)

◆ get_layout()

dimension_measurements gui::dialog_frame::get_layout ( ) const
inline

Definition at line 80 of file show_dialog.hpp.

References draw_background().

◆ handle_event()

void gui::dialog_frame::handle_event ( const SDL_Event &  event)
virtual

Implements events::sdl_handler.

Definition at line 147 of file show_dialog.cpp.

References buttons_, draw(), DRAW_ALL_EVENT, DRAW_EVENT, and set_dirty().

◆ handle_window_event()

void gui::dialog_frame::handle_window_event ( const SDL_Event &  event)
virtual

Implements events::sdl_handler.

Definition at line 134 of file show_dialog.cpp.

References set_dirty().

◆ layout() [1/2]

dialog_frame::dimension_measurements gui::dialog_frame::layout ( int  x,
int  y,
int  w,
int  h 
)

◆ layout() [2/2]

dialog_frame::dimension_measurements gui::dialog_frame::layout ( const SDL_Rect &  frame_area)

Definition at line 115 of file show_dialog.cpp.

References layout().

◆ set_dirty()

void gui::dialog_frame::set_dirty ( bool  dirty = true)

Definition at line 130 of file show_dialog.cpp.

References dirty_.

Referenced by handle_event(), and handle_window_event().

◆ set_layout()

void gui::dialog_frame::set_layout ( dimension_measurements new_dim)
inline

Definition at line 79 of file show_dialog.hpp.

◆ top_padding()

int gui::dialog_frame::top_padding ( ) const

Member Data Documentation

◆ auto_restore_

bool gui::dialog_frame::auto_restore_
private

Definition at line 108 of file show_dialog.hpp.

Referenced by draw_background().

◆ bg_

surface gui::dialog_frame::bg_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_background().

◆ bot_

surface gui::dialog_frame::bot_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by bottom_padding(), draw_border(), and layout().

◆ bot_left_

surface gui::dialog_frame::bot_left_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_border().

◆ bot_right_

surface gui::dialog_frame::bot_right_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_border().

◆ buttons_

std::vector<button*>* gui::dialog_frame::buttons_
private

Definition at line 105 of file show_dialog.hpp.

Referenced by bottom_padding(), draw(), handle_event(), and layout().

◆ default_style

const dialog_frame::style gui::dialog_frame::default_style
static

Definition at line 66 of file show_dialog.hpp.

Referenced by help::show_help().

◆ dialog_style_

const style& gui::dialog_frame::dialog_style_
private

Definition at line 104 of file show_dialog.hpp.

Referenced by draw_background().

◆ dim_

dimension_measurements gui::dialog_frame::dim_
private

Definition at line 109 of file show_dialog.hpp.

Referenced by draw(), draw_background(), draw_border(), draw_title(), and layout().

◆ dirty_

bool gui::dialog_frame::dirty_
private

Definition at line 112 of file show_dialog.hpp.

Referenced by draw(), and set_dirty().

◆ have_border_

bool gui::dialog_frame::have_border_
private

Definition at line 111 of file show_dialog.hpp.

Referenced by bottom_padding(), draw_border(), layout(), and top_padding().

◆ help_button_

button* gui::dialog_frame::help_button_
private

Definition at line 106 of file show_dialog.hpp.

Referenced by draw(), and layout().

◆ left_

surface gui::dialog_frame::left_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_border(), and layout().

◆ message_style

const dialog_frame::style gui::dialog_frame::message_style
static

Definition at line 67 of file show_dialog.hpp.

◆ preview_style

const dialog_frame::style gui::dialog_frame::preview_style
static

Definition at line 68 of file show_dialog.hpp.

◆ restorer_

surface_restorer* gui::dialog_frame::restorer_
private

Definition at line 107 of file show_dialog.hpp.

Referenced by clear_background(), draw_background(), and ~dialog_frame().

◆ right_

surface gui::dialog_frame::right_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_border(), and layout().

◆ title_

std::string gui::dialog_frame::title_
private

Definition at line 102 of file show_dialog.hpp.

Referenced by draw(), draw_title(), layout(), and top_padding().

◆ title_border_h

const int gui::dialog_frame::title_border_h = 5
static

Definition at line 65 of file show_dialog.hpp.

Referenced by layout(), and top_padding().

◆ title_border_w

const int gui::dialog_frame::title_border_w = 10
static

Definition at line 65 of file show_dialog.hpp.

Referenced by layout().

◆ titlescreen_style

const dialog_frame::style gui::dialog_frame::titlescreen_style
static

Definition at line 69 of file show_dialog.hpp.

◆ top_

surface gui::dialog_frame::top_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_border(), layout(), and top_padding().

◆ top_left_

surface gui::dialog_frame::top_left_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_border().

◆ top_right_

surface gui::dialog_frame::top_right_
private

Definition at line 110 of file show_dialog.hpp.

Referenced by draw_border().

◆ video_

CVideo& gui::dialog_frame::video_
private

Definition at line 103 of file show_dialog.hpp.

Referenced by draw(), draw_background(), draw_border(), and layout().


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