rfm2.ui.user_attrs.UserAttrWidget Class Reference

Inheritance diagram for rfm2.ui.user_attrs.UserAttrWidget:

Collaboration diagram for rfm2.ui.user_attrs.UserAttrWidget:

Public Member Functions
def	__init__
def	ui_create
def	ui_update
def	editor_show
def	editor_update
def	create_attr
def	delete_attrs
Public Member Functions inherited from rfm2.ui.common.BaseWidget
def	__init__
def	ui_create
def	ui_update
def	setup
def	create
def	update
def	conditional_visibility
def	add_param_popup_menu
def	create_navigation_popup
def	update_navigation_popup
def	__str__

Static Public Member Functions
def	refresh_available_widgets
def	refresh_widgets_options
Static Public Member Functions inherited from rfm2.ui.common.BaseWidget
def	build_navigation_popup_menu

Public Attributes
	jdata
	mayaFunc
	ui_has_builtin_connector
Public Attributes inherited from rfm2.ui.common.BaseWidget
	nattr
	label
	ctl
	widget
	desc
	param
	uiprefix
	ui_func
	ui_has_builtin_connector
	mayaFunc
	mayaSubControl

Additional Inherited Members
Static Public Attributes inherited from rfm2.ui.common.BaseWidget
list	indexTwoTypes = [kk.W_POPUP, kk.W_MAPPER, kk.W_BOOLEAN, kk.W_CHECKBOX]

Detailed Description

Creates a sub layout in which user attributes will appear.

Constructor & Destructor Documentation

def rfm2.ui.user_attrs.UserAttrWidget.__init__

(

self

)

Member Function Documentation

def rfm2.ui.user_attrs.UserAttrWidget.create_attr	(		self,
			_
	)

Read input data and calls user_attrs_add().

Args:
- Passed by Maya but ignored.

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.ui.user_attrs.UserAttrWidget.delete_attrs	(		self,
			args
	)

Get the list of selected attributes from the UI and call
user_attrs_del().

Args:
- args[0] (str): the textScrollList control name.
- args[1] (str): the metadata attr name.

Kwargs:
- kwarg:  keyword_argument.

Returns:
- return_description

Raises:
- error_type: error_condition

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.ui.user_attrs.UserAttrWidget.editor_show	(		self,
			add_state,
			del_state
	)

Show/Hide the inline editors to add or delete user attributes.

Args:
- add_state (bool): visibility state of the add editor
- del_state (bool): visibility state of the del editor

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.ui.user_attrs.UserAttrWidget.editor_update	(		self,
			suffix
	)

Update one of the inline editors.

Args:
- suffix (str): appended to the editor to build the control name.
  Must be 'Add' or 'Del'

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.ui.user_attrs.UserAttrWidget.refresh_available_widgets (   editor,   args  )

static

Update the widget menu to only display type-compatible widgets.

Args:
- editor (str): basename for all widgets.
- args[0] (str): selected type.

Here is the call graph for this function:

def rfm2.ui.user_attrs.UserAttrWidget.refresh_widgets_options (   editor,   args  )

static

Update widget options section to only enable widget-compatible
fields. Also update text field placeholder text if need be.

Args:
- editor (str): basename for all widgets.
- args[0] (str): selected widget.

def rfm2.ui.user_attrs.UserAttrWidget.ui_create

(

self

)

Create the main layout infrastructure but leaves adding user
attributes to ui_update().

def rfm2.ui.user_attrs.UserAttrWidget.ui_update

(

self

)

Here is the call graph for this function:

Member Data Documentation

rfm2.ui.user_attrs.UserAttrWidget.jdata

rfm2.ui.user_attrs.UserAttrWidget.mayaFunc

rfm2.ui.user_attrs.UserAttrWidget.ui_has_builtin_connector

---

The documentation for this class was generated from the following file:

• /data/wlw/renderman_root/rat/apps/rfm/scripts/rfm2/ui/user_attrs.py