WorkspaceStatus Class Reference

#include <ED_screen.hh>

Public Member Functions
	WorkspaceStatus (bContext *C)
Public Functions
void	item (std::string text, int icon1, int icon2=0)
void	separator (float factor=1.0f)
void	item_bool (std::string text, bool inverted, int icon1, int icon2=0)
void	range (std::string text, int icon1, int icon2)
void	opmodal (std::string text, const wmOperatorType *ot, int propvalue, bool inverted=false)

Detailed Description

Definition at line 477 of file ED_screen.hh.

Constructor & Destructor Documentation

WorkspaceStatus()

WorkspaceStatus::WorkspaceStatus

(

bContext *

C

)

Definition at line 912 of file area.cc.

References BKE_workspace_status_clear(), C, CTX_wm_manager(), CTX_wm_screen(), CTX_wm_window(), CTX_wm_workspace(), ED_area_tag_redraw(), and WM_window_status_area_find().

Member Function Documentation

item()

void WorkspaceStatus::item	(	std::string	text,
		int	icon1,
		int	icon2 = 0 )

Add a static status entry and up to two icons.

Example: [LMB][Enter] Confirm

Definition at line 958 of file area.cc.

References ed_workspace_status_icon_item(), and ed_workspace_status_text_item().

item_bool()

void WorkspaceStatus::item_bool	(	std::string	text,
		bool	inverted,
		int	icon1,
		int	icon2 = 0 )

Add a dynamic status entry with up to two icons that change appearance. Example: [CTRL] Tweak

Definition at line 979 of file area.cc.

References ed_workspace_status_icon_item(), and ed_workspace_status_text_item().

opmodal()

void WorkspaceStatus::opmodal	(	std::string	text,
		const wmOperatorType *	ot,
		int	propvalue,
		bool	inverted = false )

Add a dynamic status entry for a given property in an operator's keymap. Example: [V] X-Ray

Definition at line 989 of file area.cc.

References wmKeyMapItem::alt, wmKeyMapItem::ctrl, ed_workspace_status_icon_item(), ed_workspace_status_item(), ed_workspace_status_text_item(), ELEM, wmKeyMapItem::hyper, KM_ANY, KM_MOD_HELD, KM_NOTHING, wmKeyMapItem::oskey, ot, wmKeyMapItem::shift, wmKeyMapItem::type, UI_icon_from_event_type(), wmKeyMapItem::val, WM_keymap_active(), and WM_modalkeymap_find_propvalue().

range()

void WorkspaceStatus::range	(	std::string	text,
		int	icon1,
		int	icon2 )

Add a static status entry showing two icons separated by a dash. Example: [A]-[Z] Search

Definition at line 970 of file area.cc.

References ed_workspace_status_item(), ed_workspace_status_space(), and ed_workspace_status_text_item().

separator()

void WorkspaceStatus::separator

(

float

factor = 1.0f

)

Add extra (or negative) space between items.

Definition at line 965 of file area.cc.

References ed_workspace_status_space().

---

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

• ED_screen.hh
• area.cc