Blender V5.3
DNA_screen_types.h File Reference
#include "BLI_enum_flags.hh"
#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  blender::bScreen
struct  blender::ScrVert
struct  blender::ScrEdge
struct  blender::ScrAreaMap
struct  blender::LayoutPanelState
struct  blender::Panel
struct  blender::PanelCategoryDyn
struct  blender::PanelCategoryStack
struct  blender::uiListDyn
struct  blender::uiList
struct  blender::uiViewState
struct  blender::TransformOrientation
struct  blender::uiPreview
struct  blender::TextboxState
struct  blender::ScrGlobalAreaData
struct  blender::ScrArea_Runtime
struct  blender::ScrArea
struct  blender::ARegion
struct  blender::AssetShelfSettings
struct  blender::AssetShelf
struct  blender::RegionAssetShelf
struct  blender::FileHandler

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::bke
namespace  blender::ui

Macros

#define AREAMAP_FROM_SCREEN(screen)
#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 AREAGRID   1
#define AREAMINX   29
#define HEADER_PADDING_Y   6
#define HEADERY   (20 + HEADER_PADDING_Y)
#define RGN_TYPE_NUM   (RGN_TYPE_SCRUBBING + 1)
#define RGN_TYPE_ANY   -1
#define RGN_TYPE_IS_HEADER_ANY(regiontype)
#define RGN_ALIGN_ENUM_FROM_MASK(align)
#define RGN_ALIGN_FLAG_FROM_MASK(align)

Typedefs

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

Enumerations

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

Functions

 blender::ENUM_OPERATORS (AssetShelf_InstanceFlag)

Macro Definition Documentation

◆ AREAGRID

#define AREAGRID   1

Definition at line 599 of file DNA_screen_types.h.

Referenced by blender::area_snap_calc_location().

◆ AREAMAP_FROM_SCREEN

◆ AREAMINX

◆ HEADER_PADDING_Y

#define HEADER_PADDING_Y   6

◆ HEADERY

◆ PNL_CATEGORY_FALLBACK

#define PNL_CATEGORY_FALLBACK   "Misc"

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

Definition at line 235 of file DNA_screen_types.h.

◆ RGN_ALIGN_ENUM_FROM_MASK

◆ RGN_ALIGN_FLAG_FROM_MASK

#define RGN_ALIGN_FLAG_FROM_MASK ( align)
Value:
((align) & ~eRegion_Alignment((1 << 4) - 1))

Definition at line 748 of file DNA_screen_types.h.

Referenced by blender::region_align_info_to_area_for_headers().

◆ RGN_TYPE_ANY

◆ 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) | (1 << RGN_TYPE_SCRUBBING))) != 0)

Check for any kind of header region.

Definition at line 710 of file DNA_screen_types.h.

Referenced by blender::ui::block_func_POPOVER(), blender::ui::block_func_POPUP(), blender::region_azone_edge(), blender::ui::template_asset_shelf_popover(), and blender::wm_operator_invoke().

◆ RGN_TYPE_NUM

◆ 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 340 of file DNA_screen_types.h.

Referenced by blender::ui::handle_uilist_event(), blender::ui::uilist_ensure(), and blender::ui::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 380 of file DNA_screen_types.h.