rfm2.ui.common.StringWidget Class Reference

Inheritance diagram for rfm2.ui.common.StringWidget:

Collaboration diagram for rfm2.ui.common.StringWidget:

Public Member Functions
def	__init__ (self)
def	setup (self, desc, param, uiprefix)
def	ui_create (self)
def	ui_update (self)
Public Member Functions inherited from rfm2.ui.base_widget.BaseWidget
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	text_wgt_cc (ctl, nodeattr)
def	build_nav_popup_menu (*args)
Static Public Member Functions inherited from rfm2.ui.base_widget.BaseWidget
def	build_navigation_popup_menu (*args, **kwargs)

Public Attributes
	ui_func
	ui_has_builtin_connector
	widget
	maya_sub_control
	maya_func
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

Specialized version of NumericalWidget for string attributes.

- 'popup' can use a python function to populate the optionMenuGrp on
   ui_update(). The 'options' field of the description file should be of
   the form:
   "options": "_pyfunc_:myMenuBuildingFunction"
   - the function should have the following arguments:
     - ctl (str): the name of the top control/layout.
     - nodeattr (str): the mayaNode.attribute the control should be
       attached to.

Constructor & Destructor Documentation

__init__()

def rfm2.ui.common.StringWidget.__init__

(

self

)

Reimplemented from rfm2.ui.base_widget.BaseWidget.

Member Function Documentation

build_nav_popup_menu()

def rfm2.ui.common.StringWidget.build_nav_popup_menu ( *  args )

static

setup()

def rfm2.ui.common.StringWidget.setup	(		self,
			desc,
			param,
			uiprefix
	)

initial setup phase called before the create/update cycle.

Reimplemented from rfm2.ui.base_widget.BaseWidget.

text_wgt_cc()

def rfm2.ui.common.StringWidget.text_wgt_cc (   ctl,   nodeattr  )

static

Closure returning the function to save the widget's value in the
attribute.

ui_create()

def rfm2.ui.common.StringWidget.ui_create

(

self

)

Create the widget compatible with your data types.

Reimplemented from rfm2.ui.base_widget.BaseWidget.

Here is the caller graph for this function:

ui_update()

def rfm2.ui.common.StringWidget.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 caller graph for this function:

Member Data Documentation

maya_func

rfm2.ui.common.StringWidget.maya_func

maya_sub_control

rfm2.ui.common.StringWidget.maya_sub_control

ui_func

rfm2.ui.common.StringWidget.ui_func

ui_has_builtin_connector

rfm2.ui.common.StringWidget.ui_has_builtin_connector

widget

rfm2.ui.common.StringWidget.widget

---

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/common.py