|
Blender V5.3
|
#include <BKE_screen.hh>
Definition at line 346 of file BKE_screen.hh.
| bool blender::ARegionType::clip_gizmo_events_by_ui |
Don't handle gizmos events behind #ui::Block's with #BLOCK_CLIP_EVENTS flag set.
Definition at line 454 of file BKE_screen.hh.
Referenced by blender::ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), and blender::wm_handlers_do_gizmo_handler().
| bContextDataCallback blender::ARegionType::context |
Return context data.
Definition at line 390 of file BKE_screen.hh.
Referenced by blender::CTX_data_dir_get_ex(), blender::ctx_data_get(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), and blender::ED_spacetype_view3d().
Allows default cursor per region.
Definition at line 387 of file BKE_screen.hh.
Referenced by blender::ED_region_cursor_set(), blender::ED_spacetype_console(), blender::ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_text(), blender::ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().
| std::optional< ARegionIMECursorState >(*) blender::ARegionType::cursor_ime(wmWindow *win, const ScrArea *area, const ARegion *region, ARegionIMECursor *r_cursor) |
Report the IME cursor so the candidate window can be positioned, see ARegionIMECursorState for the results.
On #ARegionIMECursorState::PositionSet, r_cursor->rect is the region-relative cursor: used to position the IME popup. Otherwise r_cursor is left untouched.
Called on region activation and after each draw (when ARegionRuntime::do_ime is set) to position the IME candidate window.
Definition at line 413 of file BKE_screen.hh.
Referenced by blender::ED_region_do_draw(), blender::ED_spacetype_console(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_text(), and blender::ED_spacetype_view3d().
| short blender::ARegionType::do_lock |
Return without drawing. lock is set by region definition, and copied to do_lock by render. Set as bitflag value in ARegionDrawLockFlags.
Definition at line 452 of file BKE_screen.hh.
Referenced by blender::BKE_spacedata_draw_locks(), blender::ED_region_cursor_set(), blender::ED_region_do_draw(), blender::ED_region_do_layout(), and blender::wm_event_do_region_handlers().
Draw entirely, view changes should be handled here.
Definition at line 363 of file BKE_screen.hh.
Referenced by blender::ui::ED_area_type_hud(), blender::ED_region_do_draw(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_clip(), blender::ED_spacetype_console(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_info(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ED_spacetype_project(), blender::ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_text(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), blender::ui::popup_block_create(), blender::ed::spreadsheet::register_spacetype(), blender::ui::searchbox_create_generic_ex(), blender::ui::searchbox_create_menu(), blender::ui::searchbox_create_operator(), and blender::ui::tooltip_create_with_data().
Handler to draw overlays. This handler is called every draw loop.
Definition at line 371 of file BKE_screen.hh.
Referenced by blender::ED_spacetype_action(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ed::vse::ED_spacetype_sequencer(), blender::wm_draw_window_onscreen(), and blender::wm_region_draw_overlay().
| ListBaseT<RegionDrawCB> blender::ARegionType::drawcalls |
Custom drawing callbacks.
Definition at line 433 of file BKE_screen.hh.
Referenced by blender::ED_region_draw_cb_activate(), blender::ed_region_draw_cb_draw(), blender::ED_region_draw_cb_exit(), and blender::ED_region_draw_cb_remove_by_type().
| void *(*) blender::ARegionType::duplicate(void *poin) |
Split region, copy data optionally.
Definition at line 384 of file BKE_screen.hh.
Referenced by blender::BKE_area_region_copy(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), and blender::ED_spacetype_view3d().
| short blender::ARegionType::event_cursor |
Call cursor function on each move event.
Definition at line 456 of file BKE_screen.hh.
Referenced by blender::ED_spacetype_console(), blender::ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_text(), blender::region_cursor_set_ex(), and blender::ed::spreadsheet::register_spacetype().
| void(*) blender::ARegionType::exit(wmWindowManager *wm, ARegion *region) |
Exit is called when the region is hidden or removed.
Definition at line 354 of file BKE_screen.hh.
Referenced by blender::area_offscreen_exit(), blender::ED_region_exit(), and blender::ED_spacetype_view3d().
| ARegionTypeFlag blender::ARegionType::flag |
Definition at line 430 of file BKE_screen.hh.
Referenced by blender::BKE_regiontype_uses_categories(), blender::BKE_regiontype_uses_category_tabs(), blender::BKE_regiontype_uses_panel_categories_search(), blender::ED_spacetype_action(), blender::ED_spacetype_clip(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_project(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_text(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), blender::ui::panel_category_is_visible(), and blender::ed::spreadsheet::register_spacetype().
| void(*) blender::ARegionType::free(ARegion *) |
Definition at line 381 of file BKE_screen.hh.
Referenced by blender::BKE_area_region_free(), blender::ui::ED_area_type_hud(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ED_spacetype_view3d(), blender::ed::spreadsheet::register_spacetype(), blender::ui::searchbox_create_generic_ex(), and blender::ui::tooltip_create_with_data().
| ListBaseT<HeaderType> blender::ARegionType::headertypes |
Header type definitions.
Definition at line 439 of file BKE_screen.hh.
Referenced by blender::ED_region_header_layout(), and blender::ed::asset::shelf::header_regiontype_register().
| void(*) blender::ARegionType::init(wmWindowManager *wm, ARegion *region) |
Add handlers, stuff you only do once or on area/region type/size changes.
Definition at line 352 of file BKE_screen.hh.
Referenced by blender::ED_area_init(), blender::ui::ED_area_type_hud(), blender::ED_area_update_region_sizes(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_clip(), blender::ED_spacetype_console(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_info(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ED_spacetype_project(), blender::ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_text(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().
| int blender::ARegionType::keymapflag |
Default keymaps to add.
Definition at line 446 of file BKE_screen.hh.
Referenced by blender::ED_area_init(), blender::ui::ED_area_type_hud(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_clip(), blender::ED_spacetype_console(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_info(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ED_spacetype_project(), blender::ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_text(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().
Optional, compute button layout before drawing for dynamic size.
Definition at line 373 of file BKE_screen.hh.
Referenced by blender::ui::ED_area_type_hud(), blender::ED_region_do_layout(), blender::ED_spacetype_buttons(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), blender::ED_spacetype_project(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), blender::ui::popup_block_create(), blender::region_rect_recursive(), blender::ui::region_redraw_immediately(), blender::ed::spreadsheet::register_spacetype(), blender::ui::searchbox_create_generic_ex(), blender::wm_draw_area_offscreen(), and blender::wm_draw_window_offscreen().
| void(*) blender::ARegionType::listener(const wmRegionListenerParams *params) |
Contextual changes should be handled here.
Definition at line 377 of file BKE_screen.hh.
Referenced by blender::ui::ED_area_type_hud(), blender::ED_region_do_listen(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_clip(), blender::ED_spacetype_console(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_info(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ED_spacetype_project(), blender::ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), blender::ui::popup_block_create(), blender::ed::spreadsheet::register_spacetype(), and blender::ui::searchbox_create_generic_ex().
| short blender::ARegionType::lock |
Definition at line 452 of file BKE_screen.hh.
Referenced by blender::BKE_spacedata_draw_locks(), blender::ui::ED_area_type_hud(), blender::ED_spacetype_buttons(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), blender::ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().
| void(*) blender::ARegionType::message_subscribe(const wmRegionMessageSubscribeParams *params) |
Optional callback to generate subscriptions.
Definition at line 379 of file BKE_screen.hh.
Referenced by blender::ED_region_message_subscribe(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_info(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_topbar(), and blender::ED_spacetype_view3d().
| int blender::ARegionType::minsizex |
Hardcoded constraints, smaller than these values region is not visible.
Definition at line 442 of file BKE_screen.hh.
| int blender::ARegionType::minsizey |
Definition at line 442 of file BKE_screen.hh.
| ARegionType* blender::ARegionType::next |
Definition at line 347 of file BKE_screen.hh.
Called on every frame in which the region's poll succeeds, regardless of visibility, before drawing, visibility evaluation and initialization. Allows the region to override visibility.
Definition at line 396 of file BKE_screen.hh.
Referenced by blender::area_regions_poll(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), and blender::ED_spacetype_view3d().
| void(*) blender::ARegionType::on_user_resize(const ARegion *region) |
Called whenever the user changes the region's size. Not called when the size is changed through other means, like to adjust for a scaled down window.
Definition at line 402 of file BKE_screen.hh.
Referenced by blender::ED_spacetype_image(), blender::ED_spacetype_node(), blender::ED_spacetype_view3d(), blender::quadview_size_modal(), and blender::region_scale_modal().
Is called whenever the current visible View2D's region changes.
Used from user code such as view navigation/zoom operators to inform region about changes. The goal is to support zoom-to-fit features which gets disabled when manual navigation is performed.
This callback is not called on indirect changes of the current viewport (which could happen when the v2d->tot is changed and cur is adopted accordingly).
Definition at line 413 of file BKE_screen.hh.
Referenced by blender::ed::vse::ED_spacetype_sequencer(), and blender::ui::view2d_curRect_changed().
| ListBaseT<PanelType> blender::ARegionType::paneltypes |
Panels type definitions.
Definition at line 436 of file BKE_screen.hh.
Referenced by blender::buttons_context_register(), blender::buttons_main_region_layout_properties(), blender::buttons_navigation_bar_region_draw(), blender::ed::asset::shelf::catalog_selector_panel_register(), blender::ED_clip_buttons_register(), blender::ED_region_panels_ex(), blender::ED_region_panels_layout(), blender::ED_uvedit_buttons_register(), blender::ED_view3d_buttons_region_layout_ex(), blender::file_execute_region_panels_register(), blender::file_tool_props_region_panels_register(), blender::file_tools_region_panels_register(), blender::fmodifier_panel_register(), blender::fmodifier_subpanel_register(), blender::graph_buttons_register(), blender::ui::hud_panels_register(), blender::image_buttons_region_layout(), blender::image_buttons_register(), blender::modifier_panel_register(), blender::seq::modifier_panel_register(), blender::modifier_subpanel_register(), blender::nla_buttons_register(), blender::ed::space_node::node_tree_interface_panel_register(), blender::ui::panel_add_instanced(), blender::ui::panel_category_active_set(), blender::ui::Layout::popover_group(), blender::ed::asset::shelf::popover_panel_register(), blender::property_search_for_context(), blender::property_search_for_context(), blender::ed::spreadsheet::register_row_filter_panels(), blender::ui::register_scene_compositor_effects_panel(), blender::ed::vse::sequencer_buttons_register(), blender::shaderfx_panel_register(), blender::shaderfx_subpanel_register(), blender::side_region_search_all_categories(), blender::side_region_search_for_context(), blender::ed::spreadsheet::spreadsheet_data_set_region_panels_register(), blender::userpref_main_region_layout(), blender::userpref_panels_register(), and blender::view3d_buttons_register().
| bool(*) blender::ARegionType::poll(const RegionPollParams *params) |
Optional callback to decide whether the region should be treated as existing given the current context. When returning false, the region will be kept in storage, but is not available to the user in any way. Callbacks can assume that context has the owning area and space-data set.
Definition at line 361 of file BKE_screen.hh.
Referenced by blender::ED_spacetype_action(), blender::ED_spacetype_clip(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_ipo(), blender::ED_spacetype_node(), blender::ED_spacetype_project(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), and blender::region_poll().
| int blender::ARegionType::prefsizex |
When new region opens (region prefsizex/y are zero then).
Definition at line 444 of file BKE_screen.hh.
Referenced by blender::ui::ED_area_type_hud(), blender::ED_region_panels_draw(), blender::ED_region_panels_layout_ex(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_clip(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_project(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_text(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), blender::ui::expand_panel_region(), blender::ui::handler_panel_region(), blender::ui::panel_region_visible_width_ensure(), blender::region_rect_recursive(), blender::region_scale_apply_stack(), blender::region_scale_modal(), blender::ed::spreadsheet::register_spacetype(), and blender::side_panel_draw_search_block().
| int blender::ARegionType::prefsizey |
Definition at line 444 of file BKE_screen.hh.
Referenced by blender::ui::ED_area_type_hud(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_clip(), blender::ED_spacetype_console(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_info(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ED_spacetype_project(), blender::ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_text(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), blender::region_rect_recursive(), blender::region_scale_apply_stack(), and blender::ed::spreadsheet::register_spacetype().
| ARegionType * blender::ARegionType::prev |
Definition at line 347 of file BKE_screen.hh.
| int blender::ARegionType::regionid |
Unique identifier within this space, defines RGN_TYPE_xxxx.
Definition at line 349 of file BKE_screen.hh.
Referenced by blender::BKE_regiontype_from_id(), blender::BKE_regiontype_uses_category_tabs(), blender::ui::ED_area_type_hud(), blender::ed_default_handlers(), blender::ED_region_do_draw(), blender::ED_region_do_layout(), blender::ED_region_panels_draw(), blender::ED_spacetype_action(), blender::ED_spacetype_buttons(), blender::ED_spacetype_clip(), blender::ED_spacetype_console(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_info(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ED_spacetype_node(), blender::ED_spacetype_outliner(), blender::ED_spacetype_project(), blender::ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_statusbar(), blender::ED_spacetype_text(), blender::ED_spacetype_topbar(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), blender::ui::popup_block_create(), blender::ed::spreadsheet::register_spacetype(), blender::ui::searchbox_create_generic_ex(), and blender::ui::tooltip_create_with_data().
| int(*) blender::ARegionType::snap_size(const ARegion *region, int size, int axis) |
Snap the size of the region (can be NULL for no snapping).
Definition at line 375 of file BKE_screen.hh.
Referenced by blender::ED_region_snap_size_apply(), blender::ED_region_snap_size_test(), blender::ED_spacetype_clip(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_text(), blender::ED_spacetype_view3d(), and blender::region_scale_modal().