Blender: WorkspaceStatus Class Reference

Blender V4.3

#include <ED_screen.hh>

Public Member Functions
	WorkspaceStatus (bContext *C)

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

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 457 of file ED_screen.hh.

Constructor & Destructor Documentation

◆ WorkspaceStatus()

WorkspaceStatus::WorkspaceStatus ( bContext * C )

Definition at line 864 of file area.cc.

References BKE_workspace_status_clear(), 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 908 of file area.cc.

References ed_workspace_status_icon_item(), and ed_workspace_status_text_item().

Referenced by apply_shear(), area_join_modal(), area_move_apply_do(), area_move_invoke(), area_move_modal(), button_activate_state(), blender::ed::sculpt_paint::dyntopo::dyntopo_detail_size_update_header(), ED_workspace_status_text(), edbm_inset_update_header(), knife_update_header(), loopcut_init(), blender::ed::sculpt_paint::filter::sculpt_mesh_update_status_bar(), ui_block_open_begin(), UI_popup_block_ex(), UI_popup_block_invoke_ex(), ui_popup_menu_create_from_menutype(), ui_popup_menu_create_impl(), ui_textedit_begin(), and blender::ed::object::voxel_size_edit_update_header().

◆ 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 924 of file area.cc.

References ed_workspace_status_icon_item(), and ed_workspace_status_text_item().

Referenced by apply_shear(), applyEdgeSlide(), area_join_modal(), area_move_apply_do(), area_move_invoke(), area_move_modal(), blender::ed::sculpt_paint::dyntopo::dyntopo_detail_size_update_header(), edbm_inset_update_header(), and blender::ed::object::voxel_size_edit_update_header().

◆ 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 934 of file area.cc.

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

Referenced by applyEdgeSlide(), edbm_bevel_update_status_text(), and knife_update_header().

◆ 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 915 of file area.cc.

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

Referenced by ui_popup_menu_create_from_menutype().

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