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”

Type:

string, default “”, (never None)

bl_region_type

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

Type:

enum in Region Type Items, default "'HEADER'"

bl_space_type

The space where the header is going to be used in

Type:

enum in Space Type Items, default "'EMPTY'"

layout

Structure of the header in the UI

Type:

UILayout, (readonly)

draw(context)

Draw UI elements into the header UI layout

classmethod append(draw_func)

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

classmethod is_extended()
classmethod prepend(draw_func)

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

classmethod remove(draw_func)

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

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

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

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

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions