#include <memory>
#include <string>
#include "BLI_compiler_attrs.h"
#include "BLI_math_vector_types.hh"
#include "BLI_vector.hh"
#include "RNA_types.hh"
#include "BKE_context.hh"

Go to the source code of this file.

Classes
struct	wmSpaceTypeListenerParams

struct	SpaceType

struct	wmRegionListenerParams

struct	wmRegionMessageSubscribeParams

struct	RegionPollParams

struct	ARegionType

struct	PanelType

struct	LayoutPanelHeader

struct	LayoutPanelBody

struct	LayoutPanels

struct	Panel_Runtime

struct	uiListType

struct	HeaderType

struct	Header

struct	MenuType

struct	Menu

struct	AssetShelfType

Namespaces
namespace	blender

namespace	blender::bke

namespace	blender::bke::id

namespace	blender::asset_system

Macros
#define	BKE_ST_MAXNAME 64

#define	ASSET_SHELF_PREVIEW_SIZE_DEFAULT 64

Typedefs
using	uiListDrawItemFunc

using	uiListDrawFilterFunc = void ()(uiList ui_list, const bContext C, uiLayout layout)

using	uiListFilterItemsFunc

using	uiListListener = void ()(uiList ui_list, wmRegionListenerParams *params)

Enumerations
enum	{ PANEL_TYPE_DEFAULT_CLOSED = (1 << 0) , PANEL_TYPE_NO_HEADER = (1 << 1) , PANEL_TYPE_HEADER_EXPAND = (1 << 2) , PANEL_TYPE_LAYOUT_VERT_BAR = (1 << 3) , PANEL_TYPE_INSTANCED = (1 << 4) , PANEL_TYPE_NO_SEARCH = (1 << 7) }

enum class	MenuTypeFlag { ContextDependent = (1 << 0) , SearchOnKeyPress = (1 << 1) }

enum	AssetShelfTypeFlag { ASSET_SHELF_TYPE_FLAG_NO_ASSET_DRAG = (1 << 0) , ASSET_SHELF_TYPE_FLAG_DEFAULT_VISIBLE = (1 << 1) , ASSET_SHELF_TYPE_FLAG_STORE_CATALOGS_IN_PREFS = (1 << 2) , ASSET_SHELF_TYPE_FLAG_MAX }

Functions
	ENUM_OPERATORS (AssetShelfTypeFlag, ASSET_SHELF_TYPE_FLAG_MAX)

SpaceType *	BKE_spacetype_from_id (int spaceid)

ARegionType *	BKE_regiontype_from_id (const SpaceType *st, int regionid)

blender::Span< std::unique_ptr< SpaceType > >	BKE_spacetypes_list ()

void	BKE_spacetype_register (std::unique_ptr< SpaceType > st)

bool	BKE_spacetype_exists (int spaceid)

void	BKE_spacetypes_free ()

void	BKE_spacedata_freelist (ListBase *lb)

void	BKE_spacedata_copylist (ListBase lb_dst, ListBase lb_src)

void	BKE_spacedata_draw_locks (bool set)

ARegion *	BKE_spacedata_find_region_type (const SpaceLink slink, const ScrArea area, int region_type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()

void	BKE_spacedata_callback_id_remap_set (void(func)(ScrArea area, SpaceLink sl, ID old_id, ID *new_id))

void	BKE_spacedata_id_unref (ScrArea area, SpaceLink sl, ID *id)

ARegion *	BKE_area_region_copy (const SpaceType st, const ARegion region)

void	BKE_area_region_free (SpaceType st, ARegion region)

void	BKE_area_region_panels_free (ListBase *panels)

Panel *	BKE_panel_new (PanelType *panel_type)

void	BKE_panel_free (Panel *panel)

void	BKE_screen_area_free (ScrArea *area)

void	BKE_region_callback_free_gizmomap_set (void(callback)(wmGizmoMap ))

void	BKE_region_callback_refresh_tag_gizmomap_set (void(callback)(wmGizmoMap ))

LayoutPanelState *	BKE_panel_layout_panel_state_ensure (Panel panel, const char idname, bool default_closed)

ARegion *	BKE_region_find_in_listbase_by_type (const ListBase *regionbase, const int region_type)

ARegion *	BKE_area_find_region_type (const ScrArea *area, int region_type)

ARegion *	BKE_area_find_region_active_win (const ScrArea *area)

ARegion *	BKE_area_find_region_xy (const ScrArea *area, int regiontype, const int xy[2]) ATTR_NONNULL(3)

ARegion *	BKE_screen_find_region_xy (const bScreen *screen, int regiontype, const int xy[2]) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1

ARegion ARegion *	BKE_screen_find_main_region_at_xy (const bScreen *screen, int space_type, const int xy[2]) ATTR_NONNULL(1

ARegion ARegion ScrArea *	BKE_screen_find_area_from_space (const bScreen screen, const SpaceLink sl) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1

ARegion ARegion ScrArea std::optional< std::string >	BKE_screen_path_from_screen_to_space (const PointerRNA *ptr)

ScrArea *	BKE_screen_find_big_area (const bScreen *screen, int spacetype, short min)

ScrArea *	BKE_screen_area_map_find_area_xy (const ScrAreaMap *areamap, int spacetype, const int xy[2]) ATTR_NONNULL(1

ScrArea ScrArea *	BKE_screen_find_area_xy (const bScreen *screen, int spacetype, const int xy[2]) ATTR_NONNULL(1

ScrArea ScrArea void	BKE_screen_gizmo_tag_refresh (bScreen *screen)

void	BKE_screen_runtime_refresh_for_blendfile (bScreen *screen)

void	BKE_screen_view3d_sync (View3D v3d, Scene scene)

void	BKE_screen_view3d_scene_sync (bScreen screen, Scene scene)

bool	BKE_screen_is_fullscreen_area (const bScreen *screen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()

bool	BKE_screen_is_used (const bScreen *screen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()

float	BKE_screen_view3d_zoom_to_fac (float camzoom)

float	BKE_screen_view3d_zoom_from_fac (float zoomfac)

void	BKE_screen_view3d_shading_init (View3DShading *shading)

void	BKE_screen_foreach_id_screen_area (LibraryForeachIDData data, ScrArea area)

void	BKE_screen_free_data (bScreen *screen)

void	BKE_screen_area_map_free (ScrAreaMap *area_map) ATTR_NONNULL()

ScrEdge *	BKE_screen_find_edge (const bScreen screen, ScrVert v1, ScrVert *v2)

void	BKE_screen_sort_scrvert (ScrVert v1, ScrVert v2)

void	BKE_screen_remove_double_scrverts (bScreen *screen)

void	BKE_screen_remove_double_scredges (bScreen *screen)

void	BKE_screen_remove_unused_scredges (bScreen *screen)

void	BKE_screen_remove_unused_scrverts (bScreen *screen)

void	BKE_screen_header_alignment_reset (bScreen *screen)

void	BKE_screen_view3d_shading_blend_write (BlendWriter writer, View3DShading shading)

void	BKE_screen_view3d_shading_blend_read_data (BlendDataReader reader, View3DShading shading)

void	BKE_screen_area_map_blend_write (BlendWriter writer, ScrAreaMap area_map)

bool	BKE_screen_area_map_blend_read_data (BlendDataReader reader, ScrAreaMap area_map)

void	BKE_screen_view3d_do_versions_250 (View3D v3d, ListBase regions)

void	BKE_screen_area_blend_read_after_liblink (BlendLibReader reader, ID parent_id, ScrArea *area)

bool	BKE_screen_blend_read_data (BlendDataReader reader, bScreen screen)

Macro Definition Documentation

◆ ASSET_SHELF_PREVIEW_SIZE_DEFAULT

#define ASSET_SHELF_PREVIEW_SIZE_DEFAULT 64

Definition at line 539 of file BKE_screen.hh.

Referenced by blender::ed::asset::shelf::asset_shelf_default_tile_height(), blender::ed::asset::shelf::create_shelf_from_type(), and blender::ed::asset::shelf::get_shelf_for_popup().

◆ BKE_ST_MAXNAME

Typedef Documentation

◆ uiListDrawFilterFunc

using uiListDrawFilterFunc = void (*)(uiList *ui_list, const bContext *C, uiLayout *layout)

Definition at line 435 of file BKE_screen.hh.

◆ uiListDrawItemFunc

using uiListDrawItemFunc

Initial value:

 void (*)(uiList *ui_list,
                                    const bContext *C,
                                    uiLayout *layout,
                                    PointerRNA *dataptr,
                                    PointerRNA *itemptr,
                                    int icon,
                                    PointerRNA *active_dataptr,
                                    const char *active_propname,
                                    int index,
                                    int flt_flag)

Draw an item in the ui_list.

Definition at line 423 of file BKE_screen.hh.

◆ uiListFilterItemsFunc

using uiListFilterItemsFunc

Initial value:

 void (*)(uiList *ui_list,
                                       const bContext *C,
                                       PointerRNA *,
                                       const char *propname)

Definition at line 438 of file BKE_screen.hh.

◆ uiListListener

using uiListListener = void (*)(uiList *ui_list, wmRegionListenerParams *params)

Definition at line 444 of file BKE_screen.hh.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
PANEL_TYPE_DEFAULT_CLOSED
PANEL_TYPE_NO_HEADER
PANEL_TYPE_HEADER_EXPAND	Makes buttons in the header shrink/stretch to fill full layout width.
PANEL_TYPE_LAYOUT_VERT_BAR
PANEL_TYPE_INSTANCED	This panel type represents data external to the UI.
PANEL_TYPE_NO_SEARCH	Don't search panels with this type during property search.

Definition at line 353 of file BKE_screen.hh.

◆ AssetShelfTypeFlag

enum AssetShelfTypeFlag

Enumerator
ASSET_SHELF_TYPE_FLAG_NO_ASSET_DRAG	Do not trigger asset dragging on drag events. Drag events can be overridden with custom keymap items then.
ASSET_SHELF_TYPE_FLAG_DEFAULT_VISIBLE
ASSET_SHELF_TYPE_FLAG_STORE_CATALOGS_IN_PREFS
ASSET_SHELF_TYPE_FLAG_MAX

Definition at line 528 of file BKE_screen.hh.

◆ MenuTypeFlag

enum class MenuTypeFlag

strong

Enumerator
ContextDependent	Whether the menu depends on data retrieved via CTX_data_pointer_get. If it is context dependent, menu search has to scan it in different contexts.
SearchOnKeyPress	Automatically start searching in the menu when pressing a key.

Definition at line 486 of file BKE_screen.hh.

Function Documentation

◆ BKE_area_find_region_active_win()

ARegion * BKE_area_find_region_active_win ( const ScrArea * area )

Definition at line 828 of file screen.cc.

References BKE_area_find_region_type(), BLI_findlink(), and RGN_TYPE_WINDOW.

Referenced by ED_undo_operator_repeat(), ED_view3d_context_activate(), ED_view3d_context_rv3d(), texture_paint_image_from_view_exec(), and wm_operator_call_internal().

◆ BKE_area_find_region_type()

ARegion * BKE_area_find_region_type	(	const ScrArea *	area,
		int	region_type )

Find a region of type region_type in the currently active space of area.

Note: This does not work if the region to look up is not in the active space. Use BKE_spacedata_find_region_type if that may be the case.

Definition at line 815 of file screen.cc.

References LISTBASE_FOREACH.

Referenced by blender::ed::asset::shelf::active_shelf_from_area(), ANIM_deselect_keys_in_animation_editors(), ANIM_frame_channel_y_extents(), animchannels_select_filter_invoke(), BKE_area_find_region_active_win(), BKE_spacedata_find_region_type(), blend_file_thumb_from_camera(), blo_do_versions_260(), blender::ui::bonedropper_set_draw_callback_region(), buttons_start_filter_exec(), channel_draw_context_init(), clip_refresh(), console_clear_exec(), console_clear_line_exec(), console_delete_exec(), console_history_append_exec(), console_history_cycle_exec(), console_indent_exec(), console_insert_exec(), console_modal_select_apply(), console_modal_select_invoke(), console_move_exec(), console_paste_exec(), console_scrollback_append_exec(), console_selectword_invoke(), console_unindent_exec(), context_find_graph_editor(), datadropper_set_draw_callback_region(), do_version_area_change_space_to_space_action(), do_versions_area_ensure_tool_region(), ED_area_type_hud_ensure(), ED_area_type_hud_redo_region_find(), ED_drivers_editor_init(), ED_screens_header_tools_menu_create(), file_refresh(), file_smoothscroll_invoke(), graphkeys_channel_view_pick_invoke(), graphkeys_view_selected_channels_exec(), hud_panel_operator_redo_poll(), hud_region_add(), last_redo_poll(), menu_items_from_ui_create(), blender::ed::space_node::node_area_listener(), blender::ed::outliner::outliner_deactivate(), blender::ed::outliner::outliner_start_filter_exec(), region_scale_toggle_hidden(), region_toggle_exec(), blender::ed::spreadsheet::spreadsheet_main_region_draw(), text_autocomplete_modal(), text_has_properties_region(), UI_view2d_fromcontext_rwin(), userpref_execute_region_poll(), userpref_show_exec(), v3d_cursor_snap_draw_fn(), v3d_cursor_snap_poll_fn(), wm_handler_fileselect_do(), wm_keymap_item_find_props(), wm_operator_call_internal(), and WM_window_cursor_keymap_status_refresh().

◆ BKE_area_find_region_xy()

ARegion * BKE_area_find_region_xy	(	const ScrArea *	area,
		int	regiontype,
		const int	xy[2] )

Definition at line 844 of file screen.cc.

References BLI_rcti_isect_pt_v(), ELEM, LISTBASE_FOREACH, RGN_TYPE_ANY, and xy.

Referenced by annotation_draw_modal(), BKE_screen_find_main_region_at_xy(), blender::ui::bonedropper_sample_pt(), datadropper_id_sample_pt(), depthdropper_depth_sample_pt(), eyedropper_color_sample_fl(), eyedropper_cryptomatte_sample_fl(), eyedropper_get_property_button_under_mouse(), blender::ed::sculpt_paint::dyntopo::sample_detail(), v3d_cursor_snap_draw_fn(), wm_dropbox_active(), and wm_handler_op_context_get_if_valid().

◆ BKE_area_region_copy()

ARegion * BKE_area_region_copy	(	const SpaceType *	st,
		const ARegion *	region )

◆ BKE_area_region_free()

void BKE_area_region_free	(	SpaceType *	st,
		ARegion *	region )

Doesn't free the region itself.

Definition at line 563 of file screen.cc.

References BKE_area_region_panels_free(), BKE_regiontype_from_id(), BLI_freelistN(), BLI_ghash_free(), ARegionType::free, IDP_FreeProperty(), LISTBASE_FOREACH, MEM_SAFE_FREE, printf, region_free_gizmomap_callback, and RGN_FLAG_TEMP_REGIONDATA.

Referenced by BKE_screen_area_blend_read_after_liblink(), BKE_screen_area_free(), BKE_spacedata_freelist(), blo_do_versions_250(), blo_do_versions_270(), blo_do_versions_280(), do_version_area_change_space_to_space_action(), ED_area_data_copy(), ED_region_remove(), property_search_all_tabs(), regions_remove_invalid(), screen_free_data(), and ui_region_temp_remove().

◆ BKE_area_region_panels_free()

void BKE_area_region_panels_free ( ListBase * panels )

Definition at line 551 of file screen.cc.

References area_region_panels_free_recursive(), BLI_listbase_clear(), and LISTBASE_FOREACH_MUTABLE.

Referenced by BKE_area_region_free(), blo_update_defaults_screen(), and ED_region_property_search().

◆ BKE_panel_free()

void BKE_panel_free ( Panel * panel )

Definition at line 529 of file screen.cc.

References Panel::activedata, BLI_freelistN(), Panel::drawname, Panel::layout_panel_states, LISTBASE_FOREACH, MEM_freeN(), MEM_SAFE_FREE, Panel::runtime, and state.

Referenced by area_region_panels_free_recursive(), panel_delete(), ui_paneltype_draw_impl(), and ui_popup_block_free().

◆ BKE_panel_layout_panel_state_ensure()

LayoutPanelState * BKE_panel_layout_panel_state_ensure	(	Panel *	panel,
		const char *	idname,
		bool	default_closed )

Get the layout panel state for the given idname. If it does not exist yet, initialize a new panel state with the given default value.

Definition at line 502 of file screen.cc.

References BLI_addtail(), BLI_strdup(), LAYOUT_PANEL_STATE_FLAG_OPEN, Panel::layout_panel_states, LISTBASE_FOREACH, SET_FLAG_FROM_TEST, state, and STREQ.

Referenced by blender::ui::nodes::handle_node_declaration_items(), blender::panel_draw(), and uiLayoutPanel().

◆ BKE_panel_new()

Panel * BKE_panel_new ( PanelType * panel_type )

Create and free panels.

Definition at line 518 of file screen.cc.

References PanelType::idname, Panel::panelname, Panel::runtime, STRNCPY, and Panel::type.

Referenced by panel_add_instanced(), panel_list_copy(), UI_panel_begin(), ui_paneltype_draw_impl(), and UI_popup_dummy_panel_set().

◆ BKE_region_callback_free_gizmomap_set()

void BKE_region_callback_free_gizmomap_set ( void(* callback )(wmGizmoMap *) )

Gizmo-maps of a region need to be freed with the region. Uses callback to avoid low-level call.

Definition at line 497 of file screen.cc.

References callback, and region_free_gizmomap_callback.

Referenced by WM_init().

◆ BKE_region_callback_refresh_tag_gizmomap_set()

void BKE_region_callback_refresh_tag_gizmomap_set ( void(* callback )(wmGizmoMap *) )

Definition at line 464 of file screen.cc.

References callback, and region_refresh_tag_gizmomap_callback.

Referenced by WM_init().

◆ BKE_region_find_in_listbase_by_type()

ARegion * BKE_region_find_in_listbase_by_type	(	const ListBase *	regionbase,
		const int	region_type )

Find a region of type region_type in provided regionbase.

Note: this is useful for versioning where either the #Area or SpaceLink regionbase are typical inputs

Definition at line 804 of file screen.cc.

References LISTBASE_FOREACH.

Referenced by blo_do_versions_300(), and do_versions_after_linking_300().

◆ BKE_regiontype_from_id()

ARegionType * BKE_regiontype_from_id	(	const SpaceType *	st,
		int	regionid )

◆ BKE_screen_area_blend_read_after_liblink()

void BKE_screen_area_blend_read_after_liblink	(	BlendLibReader *	reader,
		ID *	parent_id,
		ScrArea *	area )

Called after lib linking process is done, to perform some validation on the read data, or some complex specific reading process that requires the data to be fully read and ID pointers to be valid.

Definition at line 1405 of file screen.cc.

References BKE_area_region_free(), BKE_spacetype_from_id(), SpaceType::blend_read_after_liblink, BLI_freelinkN(), LISTBASE_FOREACH, LISTBASE_FOREACH_MUTABLE, and regions_remove_invalid().

Referenced by screen_blend_read_after_liblink(), and window_manager_blend_read_after_liblink().