Panel(bpy_struct)

base class — bpy_struct

subclasses — InputKeyMapPanel

class bpy.types.Panel(bpy_struct)

Panel containing UI elements

bl_context

The context in which the panel belongs to. (TODO: explain the possible combinations bl_context/bl_region_type/bl_space_type)

Type :string, default “”
bl_idname

If this is set, the panel 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_PT_hello”, and bl_idname is not set by the script, then bl_idname = “OBJECT_PT_hello”

Type :string, default “”
bl_label

The panel label, shows up in the panel header at the right of the triangle used to collapse the panel.

Type :string, default “”
bl_options

Options for this panel type

Type :enum in [‘DEFAULT_CLOSED’, ‘HIDE_HEADER’], default ‘DEFAULT_CLOSED’
bl_region_type

The region where the panel is going to be used in.

Type :enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’], default ‘WINDOW’
bl_space_type

The space where the panel is going to be used in.

Type :enum in [‘EMPTY’, ‘VIEW_3D’, ‘GRAPH_EDITOR’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘IMAGE_EDITOR’, ‘INFO’, ‘SEQUENCE_EDITOR’, ‘TEXT_EDITOR’, ‘AUDIO_WINDOW’, ‘DOPESHEET_EDITOR’, ‘NLA_EDITOR’, ‘SCRIPTS_WINDOW’, ‘TIMELINE’, ‘NODE_EDITOR’, ‘LOGIC_EDITOR’, ‘CONSOLE’, ‘USER_PREFERENCES’], default ‘EMPTY’
layout

Defines the structure of the panel in the UI.

Type :UILayout, (readonly)
text

XXX todo

Type :string, default “”
classmethod poll(context)

If this method returns a non-null output, then the panel can be drawn.

Return type:boolean
draw(context)

Draw UI elements into the panel UI layout.

draw_header(context)

Draw UI elements into the panel’s header UI layout.

classmethod append(draw_func)

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

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

Inherited Properties

Inherited Functions

Previous topic

Paint(bpy_struct)

Next topic

ParentActuator(Actuator)