Header(bpy_struct)

base class — bpy_struct

class bpy.types.Header(bpy_struct)

Editor header containing UI elements

bl_idname

If this is set, the header gets a custom ID, otherwise it takes the name of the class used to define the header; for example, if the class name is “OBJECT_HT_hello”, and bl_idname is not set by the script, then bl_idname = “OBJECT_HT_hello” (default “”, never None)

Type:

str

bl_region_type

The region where the header is going to be used in (defaults to header region) (default 'HEADER')

Type:

Literal[Region Type Items]

bl_space_type

The space where the header is going to be used in (default 'EMPTY')

Type:

Literal[Space Type Items]

layout

Structure of the header in the UI (readonly)

Type:

UILayout | None

draw(context)

Draw UI elements into the header UI layout

Parameters:

context (Context | None) – The context

classmethod append(draw_func)

Append a draw function to this menu, takes the same arguments as the menus draw function

Parameters:

draw_func (Callable[[Self, Context], None]) – Draw function to append.

classmethod is_extended()

Test if any draw function has been added via append() or prepend().

Returns:

True when at least one draw function has been added.

Return type:

bool

classmethod prepend(draw_func)

Prepend a draw function to this menu, takes the same arguments as the menus draw function

Parameters:

draw_func (Callable[[Self, Context], None]) – Draw function to prepend.

classmethod remove(draw_func)

Remove a draw function that has been added to this menu.

Parameters:

draw_func (Callable[[Self, Context], None]) – Draw function previously registered via append() or prepend().

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions