The Battle for Wesnoth  1.15.0+dev
Public Member Functions | Private Attributes | List of all members
editor::mouse_action_starting_position Class Reference

Set starting position action. More...

#include <mouse_action.hpp>

Inheritance diagram for editor::mouse_action_starting_position:
Inheritance graph

Public Member Functions

 mouse_action_starting_position (const CKey &key, location_palette &palette)
 
editor_actionup_left (editor_display &disp, int x, int y)
 Left click displays a player-number-selector dialog and then creates an action or returns nullptr if cancel was pressed or there would be no change. More...
 
editor_actionclick_left (editor_display &disp, int x, int y)
 A click, possibly the beginning of a drag. More...
 
editor_actionup_right (editor_display &disp, int x, int y)
 Right click only erases the starting position if there is one. More...
 
editor_actionclick_right (editor_display &disp, int x, int y)
 A click, possibly the beginning of a drag. More...
 
virtual void set_mouse_overlay (editor_display &disp)
 Set the mouse overlay for this action. More...
 
- Public Member Functions inherited from editor::mouse_action
 mouse_action (common_palette &palette, const CKey &key)
 
virtual ~mouse_action ()
 
virtual bool has_context_menu () const
 
virtual void move (editor_display &disp, const map_location &hex)
 Mouse move (not a drag). More...
 
void update_brush_highlights (editor_display &disp, const map_location &hex)
 Unconditionally update the brush highlights for the current tool when hex is the center location. More...
 
virtual std::set< map_locationaffected_hexes (editor_display &disp, const map_location &hex)
 Locations that would be affected by a click, used by move to update highlights. More...
 
virtual editor_actiondrag_left (editor_display &disp, int x, int y, bool &partial, editor_action *last_undo)
 Drag operation. More...
 
virtual editor_actiondrag_right (editor_display &disp, int x, int y, bool &partial, editor_action *last_undo)
 Drag operation. More...
 
virtual editor_actiondrag_end_left (editor_display &disp, int x, int y)
 The end of dragging. More...
 
virtual editor_actiondrag_end_right (editor_display &disp, int x, int y)
 
virtual editor_actionkey_event (editor_display &disp, const SDL_Event &e)
 Function called by the controller on a key event for the current mouse action. More...
 
void set_toolbar_button (const theme::menu *value)
 Helper variable setter - pointer to a toolbar menu/button used for highlighting the current action. More...
 
const theme::menutoolbar_button () const
 Getter for the (possibly nullptr) associated menu/button. More...
 
common_paletteget_palette ()
 Getter for the associated palette. More...
 
virtual bool supports_brushes () const
 Whether we need the brush bar, is used to grey it out. More...
 

Private Attributes

bool click_
 
location_palettelocation_palette_
 

Additional Inherited Members

- Protected Member Functions inherited from editor::mouse_action
bool has_alt_modifier () const
 
bool has_shift_modifier () const
 
bool has_ctrl_modifier () const
 
void set_terrain_mouse_overlay (editor_display &disp, const t_translation::terrain_code &fg, const t_translation::terrain_code &bg)
 Helper function for derived classes that need a active-terrain mouse overlay. More...
 
- Protected Attributes inherited from editor::mouse_action
map_location previous_move_hex_
 The hex previously used in move operations. More...
 
const CKeykey_
 Key presses, used for modifiers (alt, shift) in some operations. More...
 

Detailed Description

Set starting position action.

Definition at line 365 of file mouse_action.hpp.

Constructor & Destructor Documentation

◆ mouse_action_starting_position()

editor::mouse_action_starting_position::mouse_action_starting_position ( const CKey key,
location_palette palette 
)
inline

Member Function Documentation

◆ click_left()

editor_action * editor::mouse_action_starting_position::click_left ( editor_display disp,
int  x,
int  y 
)
virtual

A click, possibly the beginning of a drag.

Must be overridden.

Implements editor::mouse_action.

Definition at line 428 of file mouse_action.cpp.

◆ click_right()

editor_action * editor::mouse_action_starting_position::click_right ( editor_display disp,
int  x,
int  y 
)
virtual

A click, possibly the beginning of a drag.

Must be overridden.

Implements editor::mouse_action.

Definition at line 445 of file mouse_action.cpp.

◆ set_mouse_overlay()

void editor::mouse_action_starting_position::set_mouse_overlay ( editor_display disp)
virtual

Set the mouse overlay for this action.

Defaults to an empty overlay.

Reimplemented from editor::mouse_action.

Definition at line 450 of file mouse_action.cpp.

References adjust_surface_alpha(), image::get_image(), display::get_zoom_factor(), scale_surface(), sdl_blit(), display::set_mouseover_hex_overlay(), and utf8::size().

◆ up_left()

editor_action * editor::mouse_action_starting_position::up_left ( editor_display disp,
int  x,
int  y 
)
virtual

Left click displays a player-number-selector dialog and then creates an action or returns nullptr if cancel was pressed or there would be no change.

Do this on mouse up to avoid drag issue.

Reimplemented from editor::mouse_action.

Definition at line 394 of file mouse_action.cpp.

References a, editor::mouse_action::has_ctrl_modifier(), display::hex_clicked_on(), gamemap::is_starting_position(), editor::editor_display::map(), gamemap::on_board(), and editor::mouse_action::update_brush_highlights().

◆ up_right()

editor_action * editor::mouse_action_starting_position::up_right ( editor_display disp,
int  x,
int  y 
)
virtual

Right click only erases the starting position if there is one.

Do this on mouse up to avoid drag issue,

Reimplemented from editor::mouse_action.

Definition at line 434 of file mouse_action.cpp.

References display::hex_clicked_on(), gamemap::is_starting_position(), and editor::editor_display::map().

Member Data Documentation

◆ click_

bool editor::mouse_action_starting_position::click_
private

Definition at line 392 of file mouse_action.hpp.

◆ location_palette_

location_palette& editor::mouse_action_starting_position::location_palette_
private

Definition at line 393 of file mouse_action.hpp.


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