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 panel; 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_space_type

The space where the header is going to be used in

  • EMPTY Empty.
  • VIEW_3D 3D View, 3D viewport.
  • IMAGE_EDITOR UV/Image Editor, View and edit images and UV Maps.
  • NODE_EDITOR Node Editor, Editor for node-based shading and compositing tools.
  • SEQUENCE_EDITOR Video Sequencer, Video editing tools.
  • CLIP_EDITOR Movie Clip Editor, Motion tracking tools.
  • TIMELINE Timeline, Timeline and playback controls.
  • GRAPH_EDITOR Graph Editor, Edit drivers and keyframe interpolation.
  • DOPESHEET_EDITOR Dope Sheet, Adjust timing of keyframes.
  • NLA_EDITOR NLA Editor, Combine and layer Actions.
  • TEXT_EDITOR Text Editor, Edit scripts and in-file documentation.
  • LOGIC_EDITOR Logic Editor, Game logic editing.
  • CONSOLE Python Console, Interactive programmatic console for advanced editing and script development.
  • INFO Info, Main menu bar and list of error messages (drag down to expand and display).
  • OUTLINER Outliner, Overview of scene graph and all available data-blocks.
  • PROPERTIES Properties, Edit properties of active object and related data-blocks.
  • FILE_BROWSER File Browser, Browse for files and assets.
  • USER_PREFERENCES User Preferences, Edit persistent configuration settings.
Type:enum in [‘EMPTY’, ‘VIEW_3D’, ‘IMAGE_EDITOR’, ‘NODE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘TIMELINE’, ‘GRAPH_EDITOR’, ‘DOPESHEET_EDITOR’, ‘NLA_EDITOR’, ‘TEXT_EDITOR’, ‘LOGIC_EDITOR’, ‘CONSOLE’, ‘INFO’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘USER_PREFERENCES’], default ‘EMPTY’
layout

Structure of the header in the UI

Type:UILayout, (readonly)
draw(context)

Draw UI elements into the header UI layout

classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – 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 (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type

Inherited Properties

Inherited Functions