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__ (self)
def	ui_create (self)
def	ui_update (self)
def	editor_show (self, add_state, del_state)
def	editor_update (self, suffix)
def	create_attr (self, *_)
def	delete_attrs (self, *args)
Public Member Functions inherited from rfm2.ui.base_widget.BaseWidget
def	setup (self, desc, param, uiprefix)
def	create (self, ctlname, nodeattr, param, idx=None, dyn=False, struct_name=None, struct_idx=None)
def	update (self, ctlname, nodeattr, idx=None, label=None, dyn=0, struct_name=None, struct_idx=None)
def	conditional_visibility (self, return_func=False)
def	add_param_popup_menu (self)
def	create_navigation_popup (self, ctl)
def	update_navigation_popup (self, ctl, func)
def	__str__ (self)

Static Public Member Functions
def	refresh_available_widgets (editor, *args)
def	refresh_widgets_options (editor, *args)
Static Public Member Functions inherited from rfm2.ui.base_widget.BaseWidget
def	build_navigation_popup_menu (*args, **kwargs)

Public Attributes
	jdata
	maya_func
	ui_has_builtin_connector
Public Attributes inherited from rfm2.ui.base_widget.BaseWidget
	nattr
	label
	ctl
	widget
	desc
	param
	uiprefix
	ui_func
	ui_has_builtin_connector
	maya_func
	maya_sub_control
	parent

Additional Inherited Members
Static Public Attributes inherited from rfm2.ui.base_widget.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

__init__()

def rfm2.ui.user_attrs.UserAttrWidget.__init__

(

self

)

Reimplemented from rfm2.ui.base_widget.BaseWidget.

Member Function Documentation

create_attr()

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:

delete_attrs()

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:

editor_show()

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:

editor_update()

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:

refresh_available_widgets()

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:

refresh_widgets_options()

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.

ui_create()

def rfm2.ui.user_attrs.UserAttrWidget.ui_create

(

self

)

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

Reimplemented from rfm2.ui.base_widget.BaseWidget.

Here is the caller graph for this function:

ui_update()

def rfm2.ui.user_attrs.UserAttrWidget.ui_update

(

self

)

Connect the widget previously created to a specific attribute.
We also handle conditional visibility here.

Reimplemented from rfm2.ui.base_widget.BaseWidget.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

jdata

rfm2.ui.user_attrs.UserAttrWidget.jdata

maya_func

rfm2.ui.user_attrs.UserAttrWidget.maya_func

ui_has_builtin_connector

rfm2.ui.user_attrs.UserAttrWidget.ui_has_builtin_connector

---

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

• /Users/plp/Perforce/plp_thebridge_rman_24_dev/rat/apps/rfm/scripts/rfm2/ui/user_attrs.py