Blender V5.3
blender::SpaceType Struct Reference

#include <BKE_screen.hh>

Public Member Functions

Space-type/region-type handling
 ~SpaceType ()

Public Attributes

char name [BKE_ST_MAXNAME]
int spaceid
int iconid
int struct_size
SpaceLink *(*) create (const ScrArea *area, const Scene *scene)
void(*) free (SpaceLink *sl)
void(*) init (wmWindowManager *wm, ScrArea *area)
void(*) exit (wmWindowManager *wm, ScrArea *area)
void(*) listener (const wmSpaceTypeListenerParams *params)
void(*) deactivate (ScrArea *area)
void(*) refresh (const bContext *C, ScrArea *area)
void(*) draw_pre (const bContext *C, ScrArea *area)
void(*) draw_post (const bContext *C, ScrArea *area)
SpaceLink *(*) duplicate (SpaceLink *sl)
void(*) operatortypes ()
void(*) keymap (wmKeyConfig *keyconf)
void(*) dropboxes ()
void(*) gizmos ()
bContextDataCallback context
void(*) id_remap (ScrArea *area, SpaceLink *sl, const bke::id::IDRemapper &mappings)
void(*) foreach_id (SpaceLink *space_link, LibraryForeachIDData *data)
int(*) space_subtype_get (ScrArea *area)
void(*) space_subtype_set (ScrArea *area, int value)
void(*) space_subtype_item_extend (bContext *C, EnumPropertyItem **item, int *totitem)
StringRefNull(*) space_name_get (const ScrArea *area)
int(*) space_icon_get (const ScrArea *area)
void(*) blend_read_data (BlendDataReader *reader, SpaceLink *space_link)
void(*) blend_read_after_liblink (BlendLibReader *reader, ID *parent_id, SpaceLink *space_link)
void(*) blend_write (BlendWriter *writer, SpaceLink *space_link)
ListBaseT< ARegionType > regiontypes
int keymapflag

Detailed Description

Definition at line 101 of file BKE_screen.hh.

Constructor & Destructor Documentation

◆ ~SpaceType()

Member Data Documentation

◆ blend_read_after_liblink

void(*) blender::SpaceType::blend_read_after_liblink(BlendLibReader *reader, ID *parent_id, SpaceLink *space_link)

Update pointers to other id data blocks.

Definition at line 181 of file BKE_screen.hh.

Referenced by blender::BKE_screen_area_blend_read_after_liblink().

◆ blend_read_data

void(*) blender::SpaceType::blend_read_data(BlendDataReader *reader, SpaceLink *space_link)

Update pointers for all structs directly owned by this space.

Definition at line 176 of file BKE_screen.hh.

Referenced by blender::direct_link_area().

◆ blend_write

void(*) blender::SpaceType::blend_write(BlendWriter *writer, SpaceLink *space_link)

Write all structs that should be saved in a .blend file.

Definition at line 186 of file BKE_screen.hh.

Referenced by blender::write_area().

◆ context

bContextDataCallback blender::SpaceType::context

Return context data.

Definition at line 152 of file BKE_screen.hh.

Referenced by blender::CTX_data_dir_get_ex(), and blender::ctx_data_get().

◆ create

SpaceLink *(*) blender::SpaceType::create(const ScrArea *area, const Scene *scene)

Initial allocation, after this WM will call init() too. Some editors need area and scene data (e.g. frame range) to set their initial scrolling.

Definition at line 115 of file BKE_screen.hh.

Referenced by blender::do_version_area_change_space_to_space_action(), blender::ED_area_newspace(), and blender::screen_area_spacelink_add().

◆ deactivate

void(*) blender::SpaceType::deactivate(ScrArea *area)

Called when the mouse moves out of the area.

Definition at line 127 of file BKE_screen.hh.

◆ draw_post

void(*) blender::SpaceType::draw_post(const bContext *C, ScrArea *area)

Called after the regions of this area are redrawn.

Definition at line 136 of file BKE_screen.hh.

Referenced by blender::wm_draw_area_offscreen().

◆ draw_pre

void(*) blender::SpaceType::draw_pre(const bContext *C, ScrArea *area)

Called before the regions of this area are redrawn.

Definition at line 133 of file BKE_screen.hh.

Referenced by blender::wm_draw_area_offscreen().

◆ dropboxes

void(*) blender::SpaceType::dropboxes()

On startup, define dropboxes for spacetype+regions.

Definition at line 146 of file BKE_screen.hh.

◆ duplicate

SpaceLink *(*) blender::SpaceType::duplicate(SpaceLink *sl)

After a spacedata copy, an init should result in exact same situation.

Definition at line 139 of file BKE_screen.hh.

Referenced by blender::BKE_spacedata_copylist().

◆ exit

void(*) blender::SpaceType::exit(wmWindowManager *wm, ScrArea *area)

Exit is called when the area is hidden or removed.

Definition at line 122 of file BKE_screen.hh.

Referenced by blender::area_offscreen_exit(), blender::ED_area_exit(), and blender::ED_area_newspace().

◆ foreach_id

void(*) blender::SpaceType::foreach_id(SpaceLink *space_link, LibraryForeachIDData *data)

foreach_id callback to process all ID pointers of the editor. Used indirectly by lib_query's BKE_library_foreach_ID_link when IDWALK_INCLUDE_UI bit-flag is set (through WM's foreach_id usage of BKE_screen_foreach_id_screen_area).

Definition at line 162 of file BKE_screen.hh.

Referenced by blender::BKE_screen_foreach_id_screen_area().

◆ free

void(*) blender::SpaceType::free(SpaceLink *sl)

Not free spacelink itself.

Definition at line 117 of file BKE_screen.hh.

Referenced by blender::BKE_spacedata_freelist(), and blender::ED_area_newspace().

◆ gizmos

void(*) blender::SpaceType::gizmos()

Initialize gizmo-map-types and gizmo-group-types with the region.

Definition at line 149 of file BKE_screen.hh.

◆ iconid

int blender::SpaceType::iconid

Icon lookup for menus.

Definition at line 107 of file BKE_screen.hh.

◆ id_remap

void(*) blender::SpaceType::id_remap(ScrArea *area, SpaceLink *sl, const bke::id::IDRemapper &mappings)

Used when we want to replace an ID by another (or NULL).

Definition at line 155 of file BKE_screen.hh.

Referenced by blender::ED_spacedata_id_remap(), and blender::ED_spacedata_id_remap_single().

◆ init

void(*) blender::SpaceType::init(wmWindowManager *wm, ScrArea *area)

Init is to cope with file load, screen (size) changes, check handlers.

Definition at line 120 of file BKE_screen.hh.

Referenced by blender::ED_area_init().

◆ keymap

void(*) blender::SpaceType::keymap(wmKeyConfig *keyconf)

Add default items to WM keymap.

Definition at line 144 of file BKE_screen.hh.

◆ keymapflag

int blender::SpaceType::keymapflag

Default key-maps to add.

Definition at line 194 of file BKE_screen.hh.

Referenced by blender::ED_area_init().

◆ listener

void(*) blender::SpaceType::listener(const wmSpaceTypeListenerParams *params)

Listeners can react to bContext changes.

Definition at line 124 of file BKE_screen.hh.

Referenced by blender::ED_area_do_listen().

◆ name

char blender::SpaceType::name[BKE_ST_MAXNAME]

For menus.

Definition at line 103 of file BKE_screen.hh.

Referenced by blender::BKE_spacetype_register(), and blender::regions_remove_invalid().

◆ operatortypes

void(*) blender::SpaceType::operatortypes()

Register operator types on startup.

Definition at line 142 of file BKE_screen.hh.

◆ refresh

void(*) blender::SpaceType::refresh(const bContext *C, ScrArea *area)

Refresh context, called after file-reads, ED_area_tag_refresh().

Definition at line 130 of file BKE_screen.hh.

Referenced by blender::ED_area_do_refresh().

◆ regiontypes

ListBaseT<ARegionType> blender::SpaceType::regiontypes

Region type definitions.

Definition at line 189 of file BKE_screen.hh.

Referenced by blender::BKE_regiontype_from_id(), and ~SpaceType().

◆ space_icon_get

int(*) blender::SpaceType::space_icon_get(const ScrArea *area)

Return a custom icon, based on subtype or other reason.

Definition at line 171 of file BKE_screen.hh.

Referenced by blender::ED_area_icon().

◆ space_name_get

StringRefNull(*) blender::SpaceType::space_name_get(const ScrArea *area)

Return a custom name, based on subtype or other reason.

Definition at line 169 of file BKE_screen.hh.

Referenced by blender::ED_area_name().

◆ space_subtype_get

int(*) blender::SpaceType::space_subtype_get(ScrArea *area)

Definition at line 164 of file BKE_screen.hh.

Referenced by blender::ED_area_newspace().

◆ space_subtype_item_extend

void(*) blender::SpaceType::space_subtype_item_extend(bContext *C, EnumPropertyItem **item, int *totitem)

Definition at line 166 of file BKE_screen.hh.

Referenced by blender::ED_area_newspace().

◆ space_subtype_set

void(*) blender::SpaceType::space_subtype_set(ScrArea *area, int value)

Definition at line 165 of file BKE_screen.hh.

Referenced by blender::ED_area_newspace().

◆ spaceid

int blender::SpaceType::spaceid

◆ struct_size

int blender::SpaceType::struct_size

Size of the SpaceLink derived struct.

Definition at line 109 of file BKE_screen.hh.


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