Home       Trees       Indices       Help   
Package bpy :: Module types :: Class UILayout
[hide private]
[frames] | no frames]

Class UILayout

The UI Layout Object

User interface layout in a panel or header.

References

Instance Methods [hide private]
UILayout
row(align)
row
UILayout
column(align)
column
UILayout
column_flow(columns, align)
column_flow
UILayout
box()
box
UILayout
split(percentage)
split
 
prop(text, icon, data, property, expand, slider, toggle, icon_only, event, full_event, index)
prop
 
props_enum(data, property)
props_enum
 
prop_menu_enum(text, icon, data, property)
prop_menu_enum
 
prop_enum(text, icon, data, property, value)
prop_enum
 
prop_object(text, icon, data, property, search_data, search_property)
prop_object
OperatorProperties
operator(text, icon, operator)
operator
 
operator_enums(operator, property)
operator_enums
 
operator_menu_enum(text, icon, operator, property)
operator_menu_enum
 
label(text, icon)
label
 
menu(text, icon, menu)
menu
 
separator()
separator
 
set_context_pointer(name, data)
set_context_pointer
 
template_header(menus)
template_header
 
template_dopesheet_filter(dopesheet)
template_dopesheet_filter
 
template_ID(data, property, new, open, unlink)
template_ID
 
template_any_ID(data, property, type_property, text)
template_any_ID
 
template_path_builder(data, property, root, text)
template_path_builder
UILayout
template_modifier(data)
template_modifier
UILayout
template_constraint(data)
template_constraint
 
template_preview(id, parent, slot)
template_preview
 
template_curve_mapping(data, property, type, levels)
template_curve_mapping
 
template_color_ramp(data, property, expand)
template_color_ramp
 
template_layers(data, property, used_layers_data, used_layers_property, active_layer)
template_layers
 
template_triColorSet(data, property)
template_triColorSet
 
template_image_layers(image, image_user)
template_image_layers
 
template_image(data, property, image_user, compact)
template_image
 
template_list(data, property, active_data, active_property, rows, type)
template_list
 
template_running_jobs()
template_running_jobs
 
template_operator_search()
template_operator_search
 
template_header_3D()
template_header_3D
string
introspect()
introspect
Instance Variables [hide private]
boolean active
active
enum alignment
alignment in...
boolean enabled
enabled
enum operator_context
operator_context in...
float in [0, inf] scale_x
scale_x
float in [0, inf] scale_y
scale_y
Method Details [hide private]

row(align)

 

row

Parameters:
  • align (boolean)
Returns: UILayout
Sub-layout to put items in.

column(align)

 

column

Parameters:
  • align (boolean)
Returns: UILayout
Sub-layout to put items in.

column_flow(columns, align)

 

column_flow

Parameters:
  • align (boolean)
  • columns (int)
Returns: UILayout
Sub-layout to put items in.

box()

 

box

Returns: UILayout
Sub-layout to put items in.

split(percentage)

 

split

Parameters:
  • percentage (float)
Returns: UILayout
Sub-layout to put items in.

prop(text, icon, data, property, expand, slider, toggle, icon_only, event, full_event, index)

 

prop

Parameters:
  • index (int)
  • full_event (boolean)
  • text (string)
  • event (boolean)
  • slider (boolean)
  • toggle (boolean)
  • property (string)
  • data (AnyType)
  • icon_only (boolean)
  • expand (boolean)
  • icon (enum)

props_enum(data, property)

 

props_enum

Parameters:

prop_menu_enum(text, icon, data, property)

 

prop_menu_enum

Parameters:
  • text (string)
  • property (string)
  • data (AnyType)
  • icon (enum)

prop_enum(text, icon, data, property, value)

 

prop_enum

Parameters:
  • text (string)
  • property (string)
  • data (AnyType)
  • value (string)
  • icon (enum)

prop_object(text, icon, data, property, search_data, search_property)

 

prop_object

Parameters:
  • search_property (string)
  • search_data (AnyType)
  • text (string)
  • property (string)
  • data (AnyType)
  • icon (enum)

operator(text, icon, operator)

 

operator

Parameters:
  • operator (string)
  • text (string)
  • icon (enum)
Returns: OperatorProperties
Operator properties to fill in, return when 'properties' is set to true.

operator_enums(operator, property)

 

operator_enums

Parameters:
  • operator (string)
  • property (string)

operator_menu_enum(text, icon, operator, property)

 

operator_menu_enum

Parameters:
  • operator (string)
  • text (string)
  • property (string)
  • icon (enum)

label(text, icon)

 

label

Parameters:
  • text (string)
  • icon (enum)

menu(text, icon, menu)

 

menu

Parameters:
  • text (string)
  • menu (string)
  • icon (enum)

set_context_pointer(name, data)

 

set_context_pointer

Parameters:

template_header(menus)

 

template_header

Parameters:
  • menus (boolean)

template_dopesheet_filter(dopesheet)

 

template_dopesheet_filter

Parameters:

template_ID(data, property, new, open, unlink)

 

template_ID

Parameters:
  • new (string)
  • unlink (string)
  • property (string)
  • data (AnyType)
  • open (string)

template_any_ID(data, property, type_property, text)

 

template_any_ID

Parameters:
  • text (string)
  • property (string)
  • data (AnyType)
  • type_property (string)

template_path_builder(data, property, root, text)

 

template_path_builder

Parameters:
  • root (ID)
  • property (string)
  • data (AnyType)
  • text (string)

template_modifier(data)

 

template_modifier

Parameters:
Returns: UILayout
Sub-layout to put items in.

template_constraint(data)

 

template_constraint

Parameters:
Returns: UILayout
Sub-layout to put items in.

template_preview(id, parent, slot)

 

template_preview

Parameters:

template_curve_mapping(data, property, type, levels)

 

template_curve_mapping

Parameters:
  • type (enum)
  • property (string)
  • data (AnyType)
  • levels (boolean)

template_color_ramp(data, property, expand)

 

template_color_ramp

Parameters:
  • property (string)
  • data (AnyType)
  • expand (boolean)

template_layers(data, property, used_layers_data, used_layers_property, active_layer)

 

template_layers

Parameters:
  • used_layers_property (string)
  • active_layer (int)
  • property (string)
  • data (AnyType)
  • used_layers_data (AnyType)

template_triColorSet(data, property)

 

template_triColorSet

Parameters:

template_image_layers(image, image_user)

 

template_image_layers

Parameters:

template_image(data, property, image_user, compact)

 

template_image

Parameters:

template_list(data, property, active_data, active_property, rows, type)

 

template_list

Parameters:
  • rows (int)
  • type (enum)
  • active_property (string)
  • active_data (AnyType)
  • property (string)
  • data (AnyType)

introspect()

 

introspect

Returns: string
DESCR

Instance Variable Details [hide private]

alignment

alignment in...
  • EXPAND
  • LEFT
  • CENTER
  • RIGHT
Type:
enum

operator_context

operator_context in...
  • INVOKE_DEFAULT
  • INVOKE_REGION_WIN
  • INVOKE_AREA
  • INVOKE_SCREEN
  • EXEC_DEFAULT
  • EXEC_REGION_WIN
  • EXEC_AREA
  • EXEC_SCREEN
Type:
enum

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Dec 9 12:15:58 2009 http://epydoc.sourceforge.net