DNA_screen_types.h File Reference

#include "BLI_utildefines.h"
#include "DNA_asset_types.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
#include "DNA_view2d_types.h"
#include "DNA_ID.h"

Go to the source code of this file.

Classes
struct	bScreen
struct	ScrVert
struct	ScrEdge
struct	ScrAreaMap
struct	LayoutPanelState
struct	Panel
struct	PanelCategoryDyn
struct	PanelCategoryStack
struct	uiListDyn
struct	uiList
struct	uiViewState
struct	uiViewStateLink
struct	TransformOrientation
struct	uiPreview
struct	ScrGlobalAreaData
struct	ScrArea_Runtime
struct	ScrArea
struct	ARegion
struct	AssetShelfSettings
struct	AssetShelf
struct	RegionAssetShelf
struct	FileHandler

Macros
#define	AREAMAP_FROM_SCREEN(screen)
#define	AREAGRID   1
#define	AREAMINX   29
#define	HEADER_PADDING_Y   6
#define	HEADERY   (20 + HEADER_PADDING_Y)
#define	PNL_CATEGORY_FALLBACK   "Misc"
#define	UI_LIST_AUTO_SIZE_THRESHOLD   1
#define	UILST_FLT_SORT_MASK   (((unsigned int)(UILST_FLT_SORT_REVERSE | UILST_FLT_SORT_LOCK)) - 1)
#define	RGN_TYPE_NUM   (RGN_TYPE_ASSET_SHELF_HEADER + 1)
#define	RGN_TYPE_ANY   -1
#define	RGN_TYPE_HAS_CATEGORY_MASK   (1 << RGN_TYPE_UI)
#define	RGN_TYPE_IS_HEADER_ANY(regiontype)
#define	RGN_ALIGN_ENUM_FROM_MASK(align)
#define	RGN_ALIGN_FLAG_FROM_MASK(align)

Typedefs
typedef struct ARegionRuntimeHandle	ARegionRuntimeHandle
typedef struct FileHandlerTypeHandle	FileHandlerTypeHandle
typedef struct bScreen	bScreen
typedef struct ScrVert	ScrVert
typedef struct ScrEdge	ScrEdge
typedef struct ScrAreaMap	ScrAreaMap
typedef struct LayoutPanelState	LayoutPanelState
typedef struct Panel	Panel
typedef enum uiPanelDataExpansion	uiPanelDataExpansion
typedef struct PanelCategoryDyn	PanelCategoryDyn
typedef struct PanelCategoryStack	PanelCategoryStack
typedef void(*	uiListFreeRuntimeDataFunc) (struct uiList *ui_list)
typedef struct uiListDyn	uiListDyn
typedef struct uiList	uiList
typedef enum uiViewStateFlag	uiViewStateFlag
typedef struct uiViewState	uiViewState
typedef struct uiViewStateLink	uiViewStateLink
typedef struct TransformOrientation	TransformOrientation
typedef struct uiPreview	uiPreview
typedef enum uiPreviewTag	uiPreviewTag
typedef struct ScrGlobalAreaData	ScrGlobalAreaData
typedef enum GlobalAreaAlign	GlobalAreaAlign
typedef struct ScrArea_Runtime	ScrArea_Runtime
typedef struct ScrArea	ScrArea
typedef struct ARegion	ARegion
typedef enum eScreen_Fullscreen_Flag	eScreen_Fullscreen_Flag
typedef enum eScreen_Redraws_Flag	eScreen_Redraws_Flag
typedef enum eRegion_Type	eRegion_Type
typedef struct AssetShelfSettings	AssetShelfSettings
typedef struct AssetShelf	AssetShelf
typedef struct RegionAssetShelf	RegionAssetShelf
typedef enum AssetShelfSettings_DisplayFlag	AssetShelfSettings_DisplayFlag
typedef enum AssetShelf_InstanceFlag	AssetShelf_InstanceFlag
typedef struct FileHandler	FileHandler

Enumerations
enum	LayoutPanelStateFlag { LAYOUT_PANEL_STATE_FLAG_OPEN = (1 << 0) }
enum	uiPanelDataExpansion {   UI_PANEL_DATA_EXPAND_ROOT = (1 << 0) , UI_SUBPANEL_DATA_EXPAND_1 = (1 << 1) , UI_SUBPANEL_DATA_EXPAND_2 = (1 << 2) , UI_SUBPANEL_DATA_EXPAND_3 = (1 << 3) ,   UI_SUBPANEL_DATA_EXPAND_4 = (1 << 4) , UI_SUBPANEL_DATA_EXPAND_5 = (1 << 5) , UI_SUBPANEL_DATA_EXPAND_6 = (1 << 6) , UI_SUBPANEL_DATA_EXPAND_7 = (1 << 7) ,   UI_SUBPANEL_DATA_EXPAND_8 = (1 << 8) , UI_SUBPANEL_DATA_EXPAND_9 = (1 << 9) , UI_SUBPANEL_DATA_EXPAND_10 = (1 << 10) , UI_SUBPANEL_DATA_EXPAND_11 = (1 << 11) ,   UI_SUBPANEL_DATA_EXPAND_12 = (1 << 12) , UI_SUBPANEL_DATA_EXPAND_13 = (1 << 13) , UI_SUBPANEL_DATA_EXPAND_14 = (1 << 14) , UI_SUBPANEL_DATA_EXPAND_15 = (1 << 15) }
enum	uiViewStateFlag { UI_VIEW_SHOW_FILTER_OPTIONS = (1 << 0) }
enum	uiPreviewTag { UI_PREVIEW_TAG_DIRTY = (1 << 0) }
enum	GlobalAreaFlag { GLOBAL_AREA_IS_HIDDEN = (1 << 0) }
enum	GlobalAreaAlign { GLOBAL_AREA_ALIGN_TOP = 0 , GLOBAL_AREA_ALIGN_BOTTOM = 1 }
enum	{   HEADER_NO_PULLDOWN = (1 << 0) , AREA_FLAG_REGION_SIZE_UPDATE = (1 << 3) , AREA_FLAG_ACTIVE_TOOL_UPDATE = (1 << 4) , AREA_FLAG_UNUSED_6 = (1 << 6) ,   AREA_FLAG_STACKED_FULLSCREEN = (1 << 7) , AREA_FLAG_ACTIONZONES_UPDATE = (1 << 8) , AREA_FLAG_OFFSCREEN = (1 << 9) }
enum	{ SCREEN_DEPRECATED = 1 , SCREEN_COLLAPSE_STATUSBAR = 2 }
enum	{ SCREENNORMAL = 0 , SCREENMAXIMIZED = 1 , SCREENFULL = 2 }
enum	eScreen_Fullscreen_Flag { FULLSCREEN_RESTORE_GIZMO_NAVIGATE = (1 << 0) , FULLSCREEN_RESTORE_TEXT = (1 << 1) , FULLSCREEN_RESTORE_STATS = (1 << 2) }
enum	eScreen_Redraws_Flag {   TIME_REGION = (1 << 0) , TIME_ALL_3D_WIN = (1 << 1) , TIME_ALL_ANIM_WIN = (1 << 2) , TIME_ALL_BUTS_WIN = (1 << 3) ,   TIME_SEQ = (1 << 5) , TIME_ALL_IMAGE_WIN = (1 << 6) , TIME_NODES = (1 << 8) , TIME_CLIPS = (1 << 9) ,   TIME_SPREADSHEETS = (1 << 10) , TIME_FOLLOW = (1 << 15) }
enum	{   PNL_SELECT = (1 << 0) , PNL_UNUSED_1 = (1 << 1) , PNL_CLOSED = (1 << 2) , PNL_PIN = (1 << 5) ,   PNL_POPOVER = (1 << 6) , PNL_INSTANCED_LIST_ORDER_CHANGED = (1 << 7) }
enum	{ UILST_LAYOUT_DEFAULT = 0 , UILST_LAYOUT_COMPACT = 1 , UILST_LAYOUT_BIG_PREVIEW_GRID = 3 }
enum	{ UILST_SCROLL_TO_ACTIVE_ITEM = 1 << 0 }
enum	{ UILST_FLT_ITEM_NEVER_SHOW = (1 << 16) , UILST_FLT_ITEM = 1 << 30 }
enum	{ UILST_FLT_SHOW = 1 << 0 , UILST_FLT_EXCLUDE = UILST_FLT_ITEM }
enum	{ UILST_FLT_SORT_ALPHA = 1 , UILST_FLT_SORT_LOCK = 1u << 30 , UILST_FLT_SORT_REVERSE = 1u << 31 }
enum	eRegion_Type {   RGN_TYPE_WINDOW = 0 , RGN_TYPE_HEADER = 1 , RGN_TYPE_CHANNELS = 2 , RGN_TYPE_TEMPORARY = 3 ,   RGN_TYPE_UI = 4 , RGN_TYPE_TOOLS = 5 , RGN_TYPE_TOOL_PROPS = 6 , RGN_TYPE_PREVIEW = 7 ,   RGN_TYPE_HUD = 8 , RGN_TYPE_NAV_BAR = 9 , RGN_TYPE_EXECUTE = 10 , RGN_TYPE_FOOTER = 11 ,   RGN_TYPE_TOOL_HEADER = 12 , RGN_TYPE_XR = 13 , RGN_TYPE_ASSET_SHELF = 14 , RGN_TYPE_ASSET_SHELF_HEADER = 15 }
enum	{   RGN_ALIGN_NONE = 0 , RGN_ALIGN_TOP = 1 , RGN_ALIGN_BOTTOM = 2 , RGN_ALIGN_LEFT = 3 ,   RGN_ALIGN_RIGHT = 4 , RGN_ALIGN_HSPLIT = 5 , RGN_ALIGN_VSPLIT = 6 , RGN_ALIGN_FLOAT = 7 ,   RGN_ALIGN_QSPLIT = 8 , RGN_SPLIT_PREV = 1 << 5 , RGN_SPLIT_SCALE_PREV = 1 << 6 , RGN_ALIGN_HIDE_WITH_PREV = 1 << 7 }
enum	{   RGN_FLAG_HIDDEN = (1 << 0) , RGN_FLAG_TOO_SMALL = (1 << 1) , RGN_FLAG_DYNAMIC_SIZE = (1 << 2) , RGN_FLAG_TEMP_REGIONDATA = (1 << 3) ,   RGN_FLAG_NO_USER_RESIZE = (1 << 4) , RGN_FLAG_SIZE_CLAMP_X = (1 << 5) , RGN_FLAG_SIZE_CLAMP_Y = (1 << 6) , RGN_FLAG_HIDDEN_BY_USER = (1 << 7) ,   RGN_FLAG_SEARCH_FILTER_ACTIVE = (1 << 8) , RGN_FLAG_SEARCH_FILTER_UPDATE = (1 << 9) , RGN_FLAG_POLL_FAILED = (1 << 10) , RGN_FLAG_RESIZE_RESPECT_BUTTON_SECTIONS = (1 << 11) ,   RGN_FLAG_INDICATE_OVERFLOW = (1 << 12) }
enum	{   RGN_DRAW = 1 , RGN_DRAW_PARTIAL = 2 , RGN_DRAW_NO_REBUILD = 4 , RGN_DRAWING = 8 ,   RGN_REFRESH_UI = 16 , RGN_DRAW_EDITOR_OVERLAYS = 32 }
enum	AssetShelfSettings_DisplayFlag { ASSETSHELF_SHOW_NAMES = (1 << 0) }
enum	AssetShelf_InstanceFlag { ASSETSHELF_REGION_IS_HIDDEN = (1 << 0) }

Functions
	ENUM_OPERATORS (AssetShelfSettings_DisplayFlag, ASSETSHELF_SHOW_NAMES)
	ENUM_OPERATORS (AssetShelf_InstanceFlag, ASSETSHELF_REGION_IS_HIDDEN)

Macro Definition Documentation

AREAGRID

#define AREAGRID   1

Definition at line 590 of file DNA_screen_types.h.

Referenced by area_snap_calc_location().

AREAMAP_FROM_SCREEN

#define AREAMAP_FROM_SCREEN

(

screen

)

Value:

((ScrAreaMap *)&(screen)->vertbase)

Definition at line 50 of file DNA_screen_types.h.

Referenced by actionzone_modal(), area_split_invoke(), BKE_screen_blend_read_data(), BKE_screen_find_area_xy(), screen_addarea(), screen_area_edge_from_cursor(), screen_blend_write(), screen_free_data(), screen_geom_edge_add(), screen_geom_find_active_scredge(), and screen_geom_vertex_add().

AREAMINX

#define AREAMINX   29

Definition at line 591 of file DNA_screen_types.h.

Referenced by area_docking_target(), area_move_set_limits(), area_split_allowed(), ED_area_type_hud(), ED_spacetype_buttons(), region_rect_recursive(), screen_draw_dock_preview(), and screen_geom_find_area_split_point().

HEADER_PADDING_Y

#define HEADER_PADDING_Y   6

Definition at line 592 of file DNA_screen_types.h.

Referenced by button_section_bounds_calc(), and ED_area_headersize().

HEADERY

#define HEADERY   (20 + HEADER_PADDING_Y)

Definition at line 593 of file DNA_screen_types.h.

Referenced by area_docking_target(), dopesheet_region_draw(), ED_area_type_hud(), ED_spacetype_action(), ED_spacetype_buttons(), ED_spacetype_clip(), ED_spacetype_console(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_info(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_node(), ED_spacetype_outliner(), ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_text(), ED_spacetype_topbar(), ED_spacetype_userpref(), ED_spacetype_view3d(), graph_region_draw(), nla_track_region_draw(), region_rect_recursive(), blender::ed::spreadsheet::register_spacetype(), screen_draw_dock_preview(), and set_v2d_height().

PNL_CATEGORY_FALLBACK

#define PNL_CATEGORY_FALLBACK   "Misc"

Fallback panel category (only for old scripts which need updating).

Definition at line 653 of file DNA_screen_types.h.

RGN_ALIGN_ENUM_FROM_MASK

#define RGN_ALIGN_ENUM_FROM_MASK

(

align

)

Value:

((align) & ((1 << 4) - 1))

Mask out flags so we can check the alignment.

Definition at line 775 of file DNA_screen_types.h.

Referenced by ED_area_max_regionsize(), ED_region_contains_xy(), ED_region_panel_category_gutter_calc_rect(), ED_region_panels_draw(), ED_screens_region_flip_menu_create(), image_tools_header_region_draw(), panel_region_offset_x_get(), region_align_info_from_area(), region_align_info_to_area_for_headers(), region_azones_add(), region_overlap_fix(), region_rect_recursive(), region_scale_invoke(), region_visible_rect_calc(), statusbar_header_region_init(), template_ID_tabs(), topbar_header_region_init(), topbar_main_region_init(), ui_block_func_POPOVER(), ui_block_func_POPUP(), ui_but_align_opposite_to_area_align_get(), ui_but_drag_init(), ui_handle_panel_category_cycling(), ui_item_menu_hold(), UI_panel_category_draw_all(), view3d_tools_header_region_draw(), and wm_draw_region_blend().

RGN_ALIGN_FLAG_FROM_MASK

#define RGN_ALIGN_FLAG_FROM_MASK

(

align

)

Value:

((align) & ~((1 << 4) - 1))

Definition at line 776 of file DNA_screen_types.h.

Referenced by region_align_info_to_area_for_headers().

RGN_TYPE_ANY

#define RGN_TYPE_ANY   -1

Use for function args.

Definition at line 738 of file DNA_screen_types.h.

Referenced by annotation_draw_modal(), annotation_draw_toggle_eraser_cursor(), annotation_draw_toggle_stabilizer_cursor(), BKE_area_find_region_xy(), BKE_screen_find_region_xy(), ED_area_find_region_xy_visual(), ED_paint_cursor_start(), eyedropper_get_property_button_under_mouse(), gizmo_find_from_properties(), gizmo_primitive_rna_find_operator(), blender::ed::transform::initTransform(), blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_invoke(), blender::ed::sculpt_paint::paint_stroke_modal(), pyrna_callback_classmethod_add(), radial_control_invoke(), blender::ed::sculpt_paint::image::ops::paint::texture_paint_init(), ui_button_press_invoke(), wm_drags_draw(), wm_dropbox_active(), wm_event_do_handlers_area_regions(), and wm_paintcursor_draw().

RGN_TYPE_HAS_CATEGORY_MASK

#define RGN_TYPE_HAS_CATEGORY_MASK   (1 << RGN_TYPE_UI)

Region supports panel tabs (categories).

Definition at line 741 of file DNA_screen_types.h.

Referenced by region_uses_category_tabs(), and UI_panel_category_draw_all().

RGN_TYPE_IS_HEADER_ANY

#define RGN_TYPE_IS_HEADER_ANY

(

regiontype

)

Value:

(((1 << (regiontype)) & ((1 << RGN_TYPE_HEADER) | 1 << (RGN_TYPE_TOOL_HEADER) | \
                         (1 << RGN_TYPE_FOOTER) | (1 << RGN_TYPE_ASSET_SHELF_HEADER))) != 0)

Check for any kind of header region.

Definition at line 744 of file DNA_screen_types.h.

Referenced by region_azone_edge(), blender::ui::template_asset_shelf_popover(), ui_block_func_POPOVER(), ui_block_func_POPUP(), and wm_operator_invoke().

RGN_TYPE_NUM

#define RGN_TYPE_NUM   (RGN_TYPE_ASSET_SHELF_HEADER + 1)

Definition at line 734 of file DNA_screen_types.h.

Referenced by ED_area_newspace(), region_align_info_from_area(), region_align_info_to_area(), region_align_info_to_area_for_headers(), and wm_dropbox_invoke().

UI_LIST_AUTO_SIZE_THRESHOLD

#define UI_LIST_AUTO_SIZE_THRESHOLD   1

Value (in number of items) we have to go below minimum shown items to enable auto size.

Definition at line 669 of file DNA_screen_types.h.

Referenced by ui_handle_list_event(), ui_list_ensure(), and uilist_prepare().

UILST_FLT_SORT_MASK

#define UILST_FLT_SORT_MASK   (((unsigned int)(UILST_FLT_SORT_REVERSE | UILST_FLT_SORT_LOCK)) - 1)

Definition at line 706 of file DNA_screen_types.h.

Typedef Documentation

ARegion

typedef struct ARegion ARegion

ARegionRuntimeHandle

typedef struct ARegionRuntimeHandle ARegionRuntimeHandle

Definition at line 44 of file DNA_screen_types.h.

AssetShelf

typedef struct AssetShelf AssetShelf

AssetShelf_InstanceFlag

typedef enum AssetShelf_InstanceFlag AssetShelf_InstanceFlag

AssetShelfSettings

AssetShelfSettings::AssetShelfSettings

default

Definition at line 33 of file asset_shelf_settings.cc.

AssetShelfSettings_DisplayFlag

typedef enum AssetShelfSettings_DisplayFlag AssetShelfSettings_DisplayFlag

bScreen

typedef struct bScreen bScreen

eRegion_Type

typedef enum eRegion_Type eRegion_Type

regiontype, first two are the default set.

Warning

Do NOT change order, append on end. Types are hard-coded needed.

eScreen_Fullscreen_Flag

typedef enum eScreen_Fullscreen_Flag eScreen_Fullscreen_Flag

bScreen.fullscreen_flag

eScreen_Redraws_Flag

typedef enum eScreen_Redraws_Flag eScreen_Redraws_Flag

bScreen.redraws_flag

FileHandler

typedef struct FileHandler FileHandler

FileHandlerTypeHandle

typedef struct FileHandlerTypeHandle FileHandlerTypeHandle

Definition at line 45 of file DNA_screen_types.h.

GlobalAreaAlign

typedef enum GlobalAreaAlign GlobalAreaAlign

LayoutPanelState

typedef struct LayoutPanelState LayoutPanelState

Panel

typedef struct Panel Panel

The part from uiBlock that needs saved in file.

PanelCategoryDyn

typedef struct PanelCategoryDyn PanelCategoryDyn

Notes on Panel Categories:

• #ARegion.panels_category (PanelCategoryDyn) is a runtime only list of categories collected during draw.
• ARegion.panels_category_active (PanelCategoryStack) is basically a list of strings (category id's).

Clicking on a tab moves it to the front of region->panels_category_active, If the context changes so this tab is no longer displayed, then the first-most tab in ARegion.panels_category_active is used.

This way you can change modes and always have the tab you last clicked on.

PanelCategoryStack

typedef struct PanelCategoryStack PanelCategoryStack

Region stack of active tabs.

RegionAssetShelf

typedef struct RegionAssetShelf RegionAssetShelf

Region-data for the main asset shelf region (RGN_TYPE_ASSET_SHELF). Managed by the asset shelf internals.

Contains storage for all previously activated asset shelf instances plus info on the currently active one (only one can be active at any time).

ScrArea

typedef struct ScrArea ScrArea

ScrArea_Runtime

typedef struct ScrArea_Runtime ScrArea_Runtime

ScrAreaMap

typedef struct ScrAreaMap ScrAreaMap

ScrEdge

typedef struct ScrEdge ScrEdge

ScrGlobalAreaData

typedef struct ScrGlobalAreaData ScrGlobalAreaData

ScrVert

typedef struct ScrVert ScrVert

TransformOrientation

typedef struct TransformOrientation TransformOrientation

uiList

typedef struct uiList uiList

uiListDyn

typedef struct uiListDyn uiListDyn

uiListFreeRuntimeDataFunc

typedef void(* uiListFreeRuntimeDataFunc) (struct uiList *ui_list)

Definition at line 266 of file DNA_screen_types.h.

uiPanelDataExpansion

typedef enum uiPanelDataExpansion uiPanelDataExpansion

Used for passing expansion between instanced panel data and the panels themselves. There are 16 defines because the expansion data is typically stored in a short.

Note

Expansion for instanced panels is stored in depth first order. For example, the value of UI_SUBPANEL_DATA_EXPAND_2 correspond to mean the expansion of the second sub-panel or the first sub-panel's first sub-panel.

uiPreview

typedef struct uiPreview uiPreview

Some preview UI data need to be saved in file.

uiPreviewTag

typedef enum uiPreviewTag uiPreviewTag

uiViewState

typedef struct uiViewState uiViewState

See uiViewStateLink.

uiViewStateFlag

typedef enum uiViewStateFlag uiViewStateFlag

uiViewStateLink

typedef struct uiViewStateLink uiViewStateLink

Persistent storage for some state of views (#ui::AbstractView), for storage in a region. The view state is matched to the view using the view's idname.

The actual state is stored in uiViewState, so views can manage this conveniently without having to care about the idname and listbase pointers themselves.

Enumeration Type Documentation

anonymous enum

anonymous enum

Panel.flag

Enumerator
PNL_SELECT
PNL_UNUSED_1
PNL_CLOSED
PNL_PIN
PNL_POPOVER
PNL_INSTANCED_LIST_ORDER_CHANGED	The panel has been drag-drop reordered and the instanced panel list needs to be rebuilt.

Definition at line 640 of file DNA_screen_types.h.

anonymous enum

anonymous enum

bScreen.flag

Enumerator
SCREEN_DEPRECATED
SCREEN_COLLAPSE_STATUSBAR

Definition at line 596 of file DNA_screen_types.h.

anonymous enum

anonymous enum

ARegion.alignment

Enumerator
RGN_ALIGN_NONE
RGN_ALIGN_TOP
RGN_ALIGN_BOTTOM
RGN_ALIGN_LEFT
RGN_ALIGN_RIGHT
RGN_ALIGN_HSPLIT
RGN_ALIGN_VSPLIT
RGN_ALIGN_FLOAT
RGN_ALIGN_QSPLIT
RGN_SPLIT_PREV	Region is split into the previous one, they share the same space along a common edge. Includes the RGN_ALIGN_HIDE_WITH_PREV behavior.
RGN_SPLIT_SCALE_PREV	Always let scaling this region scale the previous region instead. Useful to let regions appear like they are one (while having independent layout, scrolling, etc.).
RGN_ALIGN_HIDE_WITH_PREV	Whenever the previous region is hidden, this region becomes invisible too. RGN_FLAG_HIDDEN should only be set for the previous region, not this. The evaluated visibility respecting this flag can be queried via #ARegion.visible

Definition at line 749 of file DNA_screen_types.h.

anonymous enum

anonymous enum

bScreen.state

Enumerator
SCREENNORMAL
SCREENMAXIMIZED	One editor taking over the screen.
SCREENFULL	One editor taking over the screen with no bare-minimum UI elements. Besides making the area full-screen this disables navigation & statistics because this is part of a stereo 3D pipeline where these elements would interfere, see: !142418.

Definition at line 602 of file DNA_screen_types.h.

anonymous enum

anonymous enum

uiList.filter_flag

Enumerator
UILST_FLT_SHOW
UILST_FLT_EXCLUDE

Definition at line 687 of file DNA_screen_types.h.

anonymous enum

anonymous enum

uiList.flag

Enumerator
UILST_SCROLL_TO_ACTIVE_ITEM	Scroll list to make active item visible.

Definition at line 663 of file DNA_screen_types.h.

anonymous enum

anonymous enum

uiList.filter_sort_flag

Enumerator
UILST_FLT_SORT_ALPHA	Just for sake of consistency.
UILST_FLT_SORT_LOCK	Special flag to indicate that order is locked (not user-changeable).
UILST_FLT_SORT_REVERSE	Special value, bit-flag used to reverse order!

Definition at line 693 of file DNA_screen_types.h.

anonymous enum

anonymous enum

ARegion.flag

Enumerator
RGN_FLAG_HIDDEN
RGN_FLAG_TOO_SMALL
RGN_FLAG_DYNAMIC_SIZE	Enable dynamically changing the region size in the ARegionType::layout() callback.
RGN_FLAG_TEMP_REGIONDATA	Region data is NULL'd on read, never written.
RGN_FLAG_NO_USER_RESIZE	Region resizing by the user is disabled, but the region edge can still be dragged to hide/unhide the region.
RGN_FLAG_SIZE_CLAMP_X	Size has been clamped (floating regions only).
RGN_FLAG_SIZE_CLAMP_Y
RGN_FLAG_HIDDEN_BY_USER	When the user sets the region is hidden, needed for floating regions that may be hidden for other reasons.
RGN_FLAG_SEARCH_FILTER_ACTIVE	Property search filter is active.
RGN_FLAG_SEARCH_FILTER_UPDATE	Update the expansion of the region's panels and switch contexts. Only Set temporarily when the search filter is updated and cleared at the end of the region's layout pass. so that expansion is still interactive,
RGN_FLAG_POLL_FAILED	ARegionType.poll() failed for the current context, and the region should be treated as if it wouldn't exist. Runtime only flag.
RGN_FLAG_RESIZE_RESPECT_BUTTON_SECTIONS
RGN_FLAG_INDICATE_OVERFLOW

Definition at line 779 of file DNA_screen_types.h.

anonymous enum

anonymous enum

uiList.layout_type

Enumerator
UILST_LAYOUT_DEFAULT
UILST_LAYOUT_COMPACT
UILST_LAYOUT_BIG_PREVIEW_GRID

Definition at line 656 of file DNA_screen_types.h.

anonymous enum

anonymous enum

uiList filter flags (dyn_data)

Warning

Lower 16 bits are meant for custom use in Python, don't use them here! Only use the higher 16 bits.

Those values are used by integer RNA too, which does not handle well values > INT_MAX. So please do not use 32nd bit here.

Enumerator
UILST_FLT_ITEM_NEVER_SHOW
UILST_FLT_ITEM

Definition at line 678 of file DNA_screen_types.h.

anonymous enum

anonymous enum

#ARegion.do_draw

Enumerator
RGN_DRAW	Region must be fully redrawn.
RGN_DRAW_PARTIAL	Redraw only part of region, for sculpting and painting to get smoother stroke painting on heavy meshes.
RGN_DRAW_NO_REBUILD	For outliner, to do faster redraw without rebuilding outliner tree. For 3D viewport, to display a new progressive render sample without while other buffers and overlays remain unchanged.
RGN_DRAWING	Set while region is being drawn.
RGN_REFRESH_UI	For popups, to refresh UI layout along with drawing.
RGN_DRAW_EDITOR_OVERLAYS	Only editor overlays (currently gizmos only!) should be redrawn.

Definition at line 811 of file DNA_screen_types.h.

anonymous enum

anonymous enum

ScrArea.flag

Enumerator
HEADER_NO_PULLDOWN
AREA_FLAG_REGION_SIZE_UPDATE	Update size of regions within the area.
AREA_FLAG_ACTIVE_TOOL_UPDATE
AREA_FLAG_UNUSED_6
AREA_FLAG_STACKED_FULLSCREEN	For temporary full-screens (file browser, image editor render) that are opened above user set full-screens.
AREA_FLAG_ACTIONZONES_UPDATE	Update action zones (even if the mouse is not intersecting them).
AREA_FLAG_OFFSCREEN	For off-screen areas.

Definition at line 565 of file DNA_screen_types.h.

AssetShelf_InstanceFlag

enum AssetShelf_InstanceFlag

Enumerator
ASSETSHELF_REGION_IS_HIDDEN	Remember the last known region visibility state or this shelf, so it can be restored if the shelf is reactivated. Practically this makes the shelf visibility be remembered per mode. Continuously updated for the visible region.

Definition at line 908 of file DNA_screen_types.h.

AssetShelfSettings_DisplayFlag

enum AssetShelfSettings_DisplayFlag

Enumerator
ASSETSHELF_SHOW_NAMES

Definition at line 902 of file DNA_screen_types.h.

eRegion_Type

enum eRegion_Type

regiontype, first two are the default set.

Warning

Do NOT change order, append on end. Types are hard-coded needed.

Enumerator
RGN_TYPE_WINDOW
RGN_TYPE_HEADER
RGN_TYPE_CHANNELS
RGN_TYPE_TEMPORARY
RGN_TYPE_UI
RGN_TYPE_TOOLS
RGN_TYPE_TOOL_PROPS
RGN_TYPE_PREVIEW
RGN_TYPE_HUD
RGN_TYPE_NAV_BAR
RGN_TYPE_EXECUTE
RGN_TYPE_FOOTER
RGN_TYPE_TOOL_HEADER
RGN_TYPE_XR
RGN_TYPE_ASSET_SHELF
RGN_TYPE_ASSET_SHELF_HEADER

Definition at line 712 of file DNA_screen_types.h.

eScreen_Fullscreen_Flag

enum eScreen_Fullscreen_Flag

bScreen.fullscreen_flag

Enumerator
FULLSCREEN_RESTORE_GIZMO_NAVIGATE
FULLSCREEN_RESTORE_TEXT
FULLSCREEN_RESTORE_STATS

Definition at line 616 of file DNA_screen_types.h.

eScreen_Redraws_Flag

enum eScreen_Redraws_Flag

bScreen.redraws_flag

Enumerator
TIME_REGION
TIME_ALL_3D_WIN
TIME_ALL_ANIM_WIN
TIME_ALL_BUTS_WIN
TIME_SEQ
TIME_ALL_IMAGE_WIN
TIME_NODES
TIME_CLIPS
TIME_SPREADSHEETS
TIME_FOLLOW

Definition at line 623 of file DNA_screen_types.h.

GlobalAreaAlign

enum GlobalAreaAlign

Enumerator
GLOBAL_AREA_ALIGN_TOP
GLOBAL_AREA_ALIGN_BOTTOM

Definition at line 430 of file DNA_screen_types.h.

GlobalAreaFlag

enum GlobalAreaFlag

Enumerator
GLOBAL_AREA_IS_HIDDEN

Definition at line 426 of file DNA_screen_types.h.

LayoutPanelStateFlag

enum LayoutPanelStateFlag

Enumerator
LAYOUT_PANEL_STATE_FLAG_OPEN	If set, the panel is currently open. Otherwise it is collapsed.

Definition at line 158 of file DNA_screen_types.h.

uiPanelDataExpansion

enum uiPanelDataExpansion

Used for passing expansion between instanced panel data and the panels themselves. There are 16 defines because the expansion data is typically stored in a short.

Note

Expansion for instanced panels is stored in depth first order. For example, the value of UI_SUBPANEL_DATA_EXPAND_2 correspond to mean the expansion of the second sub-panel or the first sub-panel's first sub-panel.

Enumerator
UI_PANEL_DATA_EXPAND_ROOT
UI_SUBPANEL_DATA_EXPAND_1
UI_SUBPANEL_DATA_EXPAND_2
UI_SUBPANEL_DATA_EXPAND_3
UI_SUBPANEL_DATA_EXPAND_4
UI_SUBPANEL_DATA_EXPAND_5
UI_SUBPANEL_DATA_EXPAND_6
UI_SUBPANEL_DATA_EXPAND_7
UI_SUBPANEL_DATA_EXPAND_8
UI_SUBPANEL_DATA_EXPAND_9
UI_SUBPANEL_DATA_EXPAND_10
UI_SUBPANEL_DATA_EXPAND_11
UI_SUBPANEL_DATA_EXPAND_12
UI_SUBPANEL_DATA_EXPAND_13
UI_SUBPANEL_DATA_EXPAND_14
UI_SUBPANEL_DATA_EXPAND_15

Definition at line 216 of file DNA_screen_types.h.

uiPreviewTag

enum uiPreviewTag

Enumerator
UI_PREVIEW_TAG_DIRTY	Preview needs re-rendering, handled in ED_preview_draw().

Definition at line 401 of file DNA_screen_types.h.

uiViewStateFlag

enum uiViewStateFlag

Enumerator
UI_VIEW_SHOW_FILTER_OPTIONS

Definition at line 342 of file DNA_screen_types.h.

Function Documentation

ENUM_OPERATORS() [1/2]

ENUM_OPERATORS	(	AssetShelf_InstanceFlag	,
		ASSETSHELF_REGION_IS_HIDDEN	)

References ASSETSHELF_REGION_IS_HIDDEN.

ENUM_OPERATORS() [2/2]

ENUM_OPERATORS	(	AssetShelfSettings_DisplayFlag	,
		ASSETSHELF_SHOW_NAMES	)

References ASSETSHELF_SHOW_NAMES.