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__
def	setup
def	ui_create
def	ui_update
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	text_wgt_cc
def	build_nav_popup_menu
Static Public Member Functions inherited from rfm2.ui.common.BaseWidget
def	build_navigation_popup_menu

Public Attributes
	ui_func
	ui_has_builtin_connector
	widget
	mayaFunc
	mayaSubControl
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

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

def rfm2.ui.common.StringWidget.__init__

(

self

)

Member Function Documentation

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

static

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

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

static

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

def rfm2.ui.common.StringWidget.ui_create

(

self

)

def rfm2.ui.common.StringWidget.ui_update

(

self

)

Member Data Documentation

rfm2.ui.common.StringWidget.mayaFunc

rfm2.ui.common.StringWidget.mayaSubControl

rfm2.ui.common.StringWidget.ui_func

rfm2.ui.common.StringWidget.ui_has_builtin_connector

rfm2.ui.common.StringWidget.widget

---

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

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