`mrv.maya.ui.control`¶

Contains the most controls like buttons and sliders for more convenient use

Functions¶

mrv.maya.ui.control.noneToList(res)¶

Returns:	list instead of None

Classes¶

Epydoc: mrv.maya.ui.control.BooleanBase

class mrv.maya.ui.control.BooleanBase(*args, **kwargs)¶

Bases: mrv.maya.ui.LabelBase

Base class for boolean controls

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.BooleanGroupBase

class mrv.maya.ui.control.BooleanGroupBase(*args, **kwargs)¶

Bases: mrv.maya.ui.GroupBase, mrv.maya.ui.BooleanBase

base class for all boolean groups

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_cc1¶: Event suitable to deal with user interface callback

e_cc2¶: Event suitable to deal with user interface callback

e_cc3¶: Event suitable to deal with user interface callback

e_cc4¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_changeCommand1¶: Event suitable to deal with user interface callback

e_changeCommand2¶: Event suitable to deal with user interface callback

e_changeCommand3¶: Event suitable to deal with user interface callback

e_changeCommand4¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_of1¶: Event suitable to deal with user interface callback

e_of2¶: Event suitable to deal with user interface callback

e_of3¶: Event suitable to deal with user interface callback

e_of4¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_offCommand1¶: Event suitable to deal with user interface callback

e_offCommand2¶: Event suitable to deal with user interface callback

e_offCommand3¶: Event suitable to deal with user interface callback

e_offCommand4¶: Event suitable to deal with user interface callback

e_on1¶: Event suitable to deal with user interface callback

e_on2¶: Event suitable to deal with user interface callback

e_on3¶: Event suitable to deal with user interface callback

e_on4¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onCommand1¶: Event suitable to deal with user interface callback

e_onCommand2¶: Event suitable to deal with user interface callback

e_onCommand3¶: Event suitable to deal with user interface callback

e_onCommand4¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_da1¶

p_da2¶

p_da3¶

p_da4¶

p_data1¶

p_data2¶

p_data3¶

p_data4¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_en1¶

p_en2¶

p_en3¶

p_en4¶

p_enable¶

p_enable1¶

p_enable2¶

p_enable3¶

p_enable4¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_l1¶

p_l2¶

p_l3¶

p_l4¶

p_la2¶

p_la3¶

p_la4¶

p_label¶

p_label1¶

p_label2¶

p_label3¶

p_label4¶

p_labelArray2¶

p_labelArray3¶

p_labelArray4¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_recomputeSize¶

p_rowAttach¶

p_rs¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.Button

class mrv.maya.ui.control.Button(*args, **kwargs)¶

Bases: mrv.maya.ui.LabelBase

Simple button interface

Note:	you can only use either the onpress or the onrelease event, both together apparently do not work

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_c¶: Event suitable to deal with user interface callback

e_command¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_pressed¶: Event suitable to deal with user interface callback

e_released¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_I¶

p_S¶

p_a¶

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_b¶

p_backgroundColor¶

p_bgc¶

p_c¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_e¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_i¶

p_io¶

p_isObscured¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_n¶

p_npm¶

p_numberOfPopupMenus¶

p_o¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_s¶

p_t¶

p_u¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.ButtonGroupBase

class mrv.maya.ui.control.ButtonGroupBase(*args, **kwargs)¶

Bases: mrv.maya.ui.GroupBase

Base class for all button groups

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_bc¶: Event suitable to deal with user interface callback

e_buttonCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_bl¶

p_buttonLabel¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_eb¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_enableButton¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_rowAttach¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.CheckBoxBase

class mrv.maya.ui.control.CheckBoxBase(*args, **kwargs)¶

Bases: mrv.maya.ui.BooleanBase

Base class for checkboxes

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_useTemplate¶

p_ut¶

p_v¶

p_value¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.CheckBoxGrp

class mrv.maya.ui.control.CheckBoxGrp(*args, **kwargs)¶

Bases: mrv.maya.ui.BooleanGroupBase, mrv.maya.ui.CheckBoxBase

Note: inherits booleanBase multiple times, this does no harm

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_cc1¶: Event suitable to deal with user interface callback

e_cc2¶: Event suitable to deal with user interface callback

e_cc3¶: Event suitable to deal with user interface callback

e_cc4¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_changeCommand1¶: Event suitable to deal with user interface callback

e_changeCommand2¶: Event suitable to deal with user interface callback

e_changeCommand3¶: Event suitable to deal with user interface callback

e_changeCommand4¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_of1¶: Event suitable to deal with user interface callback

e_of2¶: Event suitable to deal with user interface callback

e_of3¶: Event suitable to deal with user interface callback

e_of4¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_offCommand1¶: Event suitable to deal with user interface callback

e_offCommand2¶: Event suitable to deal with user interface callback

e_offCommand3¶: Event suitable to deal with user interface callback

e_offCommand4¶: Event suitable to deal with user interface callback

e_on1¶: Event suitable to deal with user interface callback

e_on2¶: Event suitable to deal with user interface callback

e_on3¶: Event suitable to deal with user interface callback

e_on4¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onCommand1¶: Event suitable to deal with user interface callback

e_onCommand2¶: Event suitable to deal with user interface callback

e_onCommand3¶: Event suitable to deal with user interface callback

e_onCommand4¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_da1¶

p_da2¶

p_da3¶

p_da4¶

p_data1¶

p_data2¶

p_data3¶

p_data4¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_en1¶

p_en2¶

p_en3¶

p_en4¶

p_enable¶

p_enable1¶

p_enable2¶

p_enable3¶

p_enable4¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_l1¶

p_l2¶

p_l3¶

p_l4¶

p_la2¶

p_la3¶

p_la4¶

p_label¶

p_label1¶

p_label2¶

p_label3¶

p_label4¶

p_labelArray2¶

p_labelArray3¶

p_labelArray4¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_recomputeSize¶

p_rowAttach¶

p_rs¶

p_useTemplate¶

p_ut¶

p_v¶

p_v1¶

p_v2¶

p_v3¶

p_v4¶

p_va2¶

p_va3¶

p_va4¶

p_value¶

p_value1¶

p_value2¶

p_value3¶

p_value4¶

p_valueArray2¶

p_valueArray3¶

p_valueArray4¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.FieldBase

class mrv.maya.ui.control.FieldBase(*args, **kwargs)¶

Bases: mrv.maya.ui.SizedControl

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_ec¶: Event suitable to deal with user interface callback

e_enterCommand¶: Event suitable to deal with user interface callback

e_receiveFocusCommand¶: Event suitable to deal with user interface callback

e_rfc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_ed¶

p_editable¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.GroupBase

class mrv.maya.ui.control.GroupBase(*args, **kwargs)¶

Bases: mrv.maya.ui.SizedControl

Base allowing access to all grouped controls

Note:	using short property names to ... keep it sane

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_rowAttach¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.IconTextBase

class mrv.maya.ui.control.IconTextBase¶

Bases: object

Base class for all icon text like controls

e_handleNodeDropCallback¶: Event suitable to deal with user interface callback

e_hnd¶: Event suitable to deal with user interface callback

e_labelEditingCallback¶: Event suitable to deal with user interface callback

e_lec¶: Event suitable to deal with user interface callback

p_di¶

p_disabledImage¶

p_fn¶

p_font¶

p_hi¶

p_highlightImage¶

p_i¶

p_i1¶

p_i2¶

p_i3¶

p_image¶

p_image1¶

p_image2¶

p_image3¶

p_imageOverlayLabel¶

p_iol¶

p_labelOffset¶

p_lo¶

p_selectionImage¶

p_si¶

p_st¶

p_style¶

Epydoc: mrv.maya.ui.control.IconTextButton

class mrv.maya.ui.control.IconTextButton(*args, **kwargs)¶

Bases: mrv.maya.ui.LabelBase, mrv.maya.ui.IconTextBase

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_c¶: Event suitable to deal with user interface callback

e_command¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_handleNodeDropCallback¶: Event suitable to deal with user interface callback

e_hnd¶: Event suitable to deal with user interface callback

e_labelEditingCallback¶: Event suitable to deal with user interface callback

e_lec¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_di¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_disabledImage¶

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_hi¶

p_highlightImage¶

p_i¶

p_i1¶

p_i2¶

p_i3¶

p_image¶

p_image1¶

p_image2¶

p_image3¶

p_imageOverlayLabel¶

p_io¶

p_iol¶

p_isObscured¶

p_l¶

p_label¶

p_labelOffset¶

p_lo¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_selectionImage¶

p_si¶

p_st¶

p_style¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.IconTextCheckBox

class mrv.maya.ui.control.IconTextCheckBox(*args, **kwargs)¶

Bases: mrv.maya.ui.CheckBoxBase, mrv.maya.ui.IconTextBase

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_handleNodeDropCallback¶: Event suitable to deal with user interface callback

e_hnd¶: Event suitable to deal with user interface callback

e_labelEditingCallback¶: Event suitable to deal with user interface callback

e_lec¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_di¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_disabledImage¶

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_hi¶

p_highlightImage¶

p_i¶

p_i1¶

p_i2¶

p_i3¶

p_image¶

p_image1¶

p_image2¶

p_image3¶

p_imageOverlayLabel¶

p_io¶

p_iol¶

p_isObscured¶

p_l¶

p_label¶

p_labelOffset¶

p_lo¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_selectionImage¶

p_si¶

p_st¶

p_style¶

p_useTemplate¶

p_ut¶

p_v¶

p_value¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.IconTextRadioButton

class mrv.maya.ui.control.IconTextRadioButton(*args, **kwargs)¶

Bases: mrv.maya.ui.RadioButtonBase, mrv.maya.ui.IconTextBase

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_handleNodeDropCallback¶: Event suitable to deal with user interface callback

e_hnd¶: Event suitable to deal with user interface callback

e_labelEditingCallback¶: Event suitable to deal with user interface callback

e_lec¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_di¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_disabledImage¶

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_hi¶

p_highlightImage¶

p_i¶

p_i1¶

p_i2¶

p_i3¶

p_image¶

p_image1¶

p_image2¶

p_image3¶

p_imageOverlayLabel¶

p_io¶

p_iol¶

p_isObscured¶

p_l¶

p_label¶

p_labelOffset¶

p_lo¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_select¶

p_selectionImage¶

p_si¶

p_sl¶

p_st¶

p_style¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.IconTextRadioCollection

class mrv.maya.ui.control.IconTextRadioCollection(*args, **kwargs)¶

Bases: mrv.maya.ui.RadioCollectionBase, mrv.maya.ui.NamedUI

Required for multiple inhertance :note: it inherits exists() and a few others which are actually not supported for some reason

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_cia¶

p_collectionItemArray¶

p_dcm¶

p_disableCommands¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_gl¶

p_global¶

p_nci¶

p_numberOfCollectionItems¶

p_select¶

p_sl¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.LabelBase

class mrv.maya.ui.control.LabelBase(*args, **kwargs)¶

Bases: mrv.maya.ui.SizedControl

Base class for elements having labels

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.OptionMenu

class mrv.maya.ui.control.OptionMenu(*args, **kwargs)¶

Bases: mrv.maya.ui.OptionMenuBase, mrv.maya.ui.SizedControl

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

Note:	Order of inheritance matters due to method resolution order !

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

clearChildren()¶: Clear our child arrays to quickly forget about our children

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

listChildren(predicate=<function <lambda> at 0x6063578>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_ill¶

p_ils¶

p_io¶

p_isObscured¶

p_itemListLong¶

p_itemListShort¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_ni¶

p_npm¶

p_numberOfItems¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_select¶

p_sl¶

p_useTemplate¶

p_ut¶

p_v¶

p_value¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setActive()¶

Make ourselves the active menu

Returns:	self

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

setParentActive()¶

Make our parent the active menu layout

Returns:	self
Note:	only useful self is a submenu

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.OptionMenuBase

class mrv.maya.ui.control.OptionMenuBase(*args, **kwargs)¶

Bases: mrv.maya.ui.base.ContainerMenuBase

base class for all optionMenu like controls

add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

clearChildren()¶: Clear our child arrays to quickly forget about our children

deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

listChildren(predicate=<function <lambda> at 0x6063578>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

p_ill¶

p_ils¶

p_itemListLong¶

p_itemListShort¶

p_l¶

p_label¶

p_ni¶

p_numberOfItems¶

p_select¶

p_sl¶

p_v¶

p_value¶

removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

setActive()¶

Make ourselves the active menu

Returns:	self

setParentActive()¶

Make our parent the active menu layout

Returns:	self
Note:	only useful self is a submenu

Epydoc: mrv.maya.ui.control.OptionMenuGrp

class mrv.maya.ui.control.OptionMenuGrp(*args, **kwargs)¶

Bases: mrv.maya.ui.OptionMenuBase, mrv.maya.ui.GroupBase

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

Note:	Order of inheritance matters due to method resolution order !

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

clearChildren()¶: Clear our child arrays to quickly forget about our children

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

listChildren(predicate=<function <lambda> at 0x6063578>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_ill¶

p_ils¶

p_io¶

p_isObscured¶

p_itemListLong¶

p_itemListShort¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_ni¶

p_npm¶

p_numberOfItems¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_rowAttach¶

p_select¶

p_sl¶

p_useTemplate¶

p_ut¶

p_v¶

p_value¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setActive()¶: The optionMenuGrp cannot be set as a parent as it is classified as control layout. A problem arises if you actually try to add new menuItems to it after it’s creation which does not work as it is not a menu

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

setParentActive()¶: See setActive

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.RadioButtonBase

class mrv.maya.ui.control.RadioButtonBase(*args, **kwargs)¶

Bases: mrv.maya.ui.BooleanBase

Base class for radio buttons

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_select¶

p_sl¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.RadioButtonGrp

class mrv.maya.ui.control.RadioButtonGrp(*args, **kwargs)¶

Bases: mrv.maya.ui.BooleanGroupBase, mrv.maya.ui.RadioButtonBase

Warning: inherits booleanBase multiple times

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_cc1¶: Event suitable to deal with user interface callback

e_cc2¶: Event suitable to deal with user interface callback

e_cc3¶: Event suitable to deal with user interface callback

e_cc4¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_changeCommand1¶: Event suitable to deal with user interface callback

e_changeCommand2¶: Event suitable to deal with user interface callback

e_changeCommand3¶: Event suitable to deal with user interface callback

e_changeCommand4¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_of1¶: Event suitable to deal with user interface callback

e_of2¶: Event suitable to deal with user interface callback

e_of3¶: Event suitable to deal with user interface callback

e_of4¶: Event suitable to deal with user interface callback

e_ofc¶: Event suitable to deal with user interface callback

e_offCommand¶: Event suitable to deal with user interface callback

e_offCommand1¶: Event suitable to deal with user interface callback

e_offCommand2¶: Event suitable to deal with user interface callback

e_offCommand3¶: Event suitable to deal with user interface callback

e_offCommand4¶: Event suitable to deal with user interface callback

e_on1¶: Event suitable to deal with user interface callback

e_on2¶: Event suitable to deal with user interface callback

e_on3¶: Event suitable to deal with user interface callback

e_on4¶: Event suitable to deal with user interface callback

e_onCommand¶: Event suitable to deal with user interface callback

e_onCommand1¶: Event suitable to deal with user interface callback

e_onCommand2¶: Event suitable to deal with user interface callback

e_onCommand3¶: Event suitable to deal with user interface callback

e_onCommand4¶: Event suitable to deal with user interface callback

e_onc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_da1¶

p_da2¶

p_da3¶

p_da4¶

p_data1¶

p_data2¶

p_data3¶

p_data4¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_en1¶

p_en2¶

p_en3¶

p_en4¶

p_enable¶

p_enable1¶

p_enable2¶

p_enable3¶

p_enable4¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_l1¶

p_l2¶

p_l3¶

p_l4¶

p_la2¶

p_la3¶

p_la4¶

p_label¶

p_label1¶

p_label2¶

p_label3¶

p_label4¶

p_labelArray2¶

p_labelArray3¶

p_labelArray4¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_recomputeSize¶

p_rowAttach¶

p_rs¶

p_select¶

p_sl¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.RadioCollection

class mrv.maya.ui.control.RadioCollection(*args, **kwargs)¶

Bases: mrv.maya.ui.RadioCollectionBase, mrv.maya.ui.NamedUI

Required for multiple inhertance

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_cia¶

p_collectionItemArray¶

p_dcm¶

p_disableCommands¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_gl¶

p_global¶

p_nci¶

p_numberOfCollectionItems¶

p_select¶

p_sl¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.RadioCollectionBase

class mrv.maya.ui.control.RadioCollectionBase¶

Bases: object

Keeps common properties

p_cia¶

p_collectionItemArray¶

p_dcm¶

p_disableCommands¶

p_gl¶

p_global¶

p_nci¶

p_numberOfCollectionItems¶

p_select¶

p_sl¶

Epydoc: mrv.maya.ui.control.RadioMenuItemCollection

class mrv.maya.ui.control.RadioMenuItemCollection(*args, **kwargs)¶

Bases: mrv.maya.ui.RadioCollectionBase, mrv.maya.ui.NamedUI

Required for multiple inhertance

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_cia¶

p_collectionItemArray¶

p_dcm¶

p_disableCommands¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_gl¶

p_global¶

p_nci¶

p_numberOfCollectionItems¶

p_select¶

p_sl¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.ScrollField

class mrv.maya.ui.control.ScrollField(*args, **kwargs)¶

Bases: mrv.maya.ui.SizedControl

Note:	although the class shares some properties of the textfield, it does not share all of them

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_ec¶: Event suitable to deal with user interface callback

e_enterCommand¶: Event suitable to deal with user interface callback

e_keyPressCommand¶: Event suitable to deal with user interface callback

e_kpc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cl¶

p_clear¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_ed¶

p_editable¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_insertText¶

p_insertionPosition¶

p_io¶

p_ip¶

p_isObscured¶

p_it¶

p_m¶

p_manage¶

p_nl¶

p_npm¶

p_numberOfLines¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_selection¶

p_sl¶

p_text¶

p_tx¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

p_wordWrap¶

p_ww¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.Separator

class mrv.maya.ui.control.Separator(*args, **kwargs)¶

Bases: mrv.maya.ui.SizedControl, mrv.maya.ui.NamedUI

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_horizontal¶

p_hr¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_st¶

p_style¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.SliderBase

class mrv.maya.ui.control.SliderBase(*args, **kwargs)¶

Bases: mrv.maya.ui.SizedControl

Class contributing Simple Slider Events

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dc¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dragCommand¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_horizontal¶

p_hr¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_max¶

p_maxValue¶

p_min¶

p_minValue¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_s¶

p_step¶

p_useTemplate¶

p_ut¶

p_v¶

p_value¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.SliderGroupBase

class mrv.maya.ui.control.SliderGroupBase(*args, **kwargs)¶

Bases: mrv.maya.ui.GroupBase, mrv.maya.ui.SliderBase

base class for all sliders

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dc¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dragCommand¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_el¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_extraLabel¶

p_fieldMaxValue¶

p_fieldMinValue¶

p_fieldStep¶

p_fmn¶

p_fmx¶

p_fpn¶

p_fs¶

p_fullPathName¶

p_h¶

p_height¶

p_horizontal¶

p_hr¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_max¶

p_maxValue¶

p_min¶

p_minValue¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_rowAttach¶

p_s¶

p_sliderStep¶

p_ss¶

p_step¶

p_useTemplate¶

p_ut¶

p_v¶

p_value¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.Text

class mrv.maya.ui.control.Text(*args, **kwargs)¶

Bases: mrv.maya.ui.LabelBase

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_al¶

p_align¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_l¶

p_label¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_recomputeSize¶

p_rs¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.TextField

class mrv.maya.ui.control.TextField(*args, **kwargs)¶

Bases: mrv.maya.ui.FieldBase, mrv.maya.ui.TextFieldBase

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_ec¶: Event suitable to deal with user interface callback

e_enterCommand¶: Event suitable to deal with user interface callback

e_receiveFocusCommand¶: Event suitable to deal with user interface callback

e_rfc¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_ed¶

p_editable¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fileName¶

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_insertPositionfi¶

p_insertText¶

p_io¶

p_ip¶

p_isObscured¶

p_it¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_text¶

p_tx¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.TextFieldBase

class mrv.maya.ui.control.TextFieldBase¶

Bases: object

Base just containing properties and events

p_fileName¶

p_fn¶

p_font¶

p_insertPositionfi¶

p_insertText¶

p_ip¶

p_it¶

p_text¶

p_tx¶

Epydoc: mrv.maya.ui.control.TextFieldButtonGrp

class mrv.maya.ui.control.TextFieldButtonGrp(*args, **kwargs)¶

Bases: mrv.maya.ui.ButtonGroupBase, mrv.maya.ui.TextFieldGroupBase

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_bc¶: Event suitable to deal with user interface callback

e_buttonCommand¶: Event suitable to deal with user interface callback

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_fcc¶: Event suitable to deal with user interface callback

e_forceChangeCommand¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_bl¶

p_buttonLabel¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_eb¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_enableButton¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fileName¶

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_insertPositionfi¶

p_insertText¶

p_io¶

p_ip¶

p_isObscured¶

p_it¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_rowAttach¶

p_text¶

p_tx¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.TextFieldGroupBase

class mrv.maya.ui.control.TextFieldGroupBase¶

Bases: mrv.maya.ui.TextFieldBase

Common base for the group text fields

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_fcc¶: Event suitable to deal with user interface callback

e_forceChangeCommand¶: Event suitable to deal with user interface callback

p_fileName¶

p_fn¶

p_font¶

p_insertPositionfi¶

p_insertText¶

p_ip¶

p_it¶

p_text¶

p_tx¶

Epydoc: mrv.maya.ui.control.TextFieldGrp

class mrv.maya.ui.control.TextFieldGrp(*args, **kwargs)¶

Bases: mrv.maya.ui.GroupBase, mrv.maya.ui.TextFieldGroupBase

Class just for multiple inheritance - this cannot be expressed in the hierarchy file

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_fcc¶: Event suitable to deal with user interface callback

e_forceChangeCommand¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_cal¶

p_cat¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fileName¶

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_insertPositionfi¶

p_insertText¶

p_io¶

p_ip¶

p_isObscured¶

p_it¶

p_m¶

p_manage¶

p_npm¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_rowAttach¶

p_text¶

p_tx¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.TextScrollList

class mrv.maya.ui.control.TextScrollList(*args, **kwargs)¶

Bases: mrv.maya.ui.SizedControl

Class defining attributes and events for the text-scroll list

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

addItem(item)¶: Add the given item to the end of the list :return: self

addItems(items)¶: Add multiple items to the end of the list :return: self

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dcc¶: Event suitable to deal with user interface callback

e_deleteKeyCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dkc¶: Event suitable to deal with user interface callback

e_doubleClickCommand¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_sc¶: Event suitable to deal with user interface callback

e_selectCommand¶: Event suitable to deal with user interface callback

e_vcc¶: Event suitable to deal with user interface callback

e_visibleChangeCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

items()¶

Returns:	list of currently available items

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_a¶

p_aas¶

p_ai¶

p_allItems¶

p_allowAutomaticSelection¶

p_allowMultiSelection¶

p_ams¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_ap¶

p_append¶

p_appendPosition¶

p_backgroundColor¶

p_bgc¶

p_da¶

p_defineTemplate¶

p_deselectAll¶

p_deselectIndexedItem¶

p_deselectItem¶

p_di¶

p_dii¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_ebg¶

p_en¶

p_enable¶

p_enableBackground¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fn¶

p_font¶

p_fpn¶

p_fullPathName¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_ni¶

p_npm¶

p_nr¶

p_nsi¶

p_numberOfItems¶

p_numberOfPopupMenus¶

p_numberOfRows¶

p_numberOfSelectedItems¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_raremoveItem¶

p_removeAll¶

p_removeIndexedItem¶

p_ri¶

p_rii¶

p_selectIndexedItem¶

p_selectItem¶

p_shi¶

p_showIndexedItem¶

p_si¶

p_sii¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

removeItem(item)¶: Remove the given item from the list. It is not an error if it doesn’t exist in the first place :return: self

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

selectedIndex()¶

Returns:	First selected index - the index is 1-based, or -1 if there

is nothing selected :note: even if multiple selections are possible

selectedIndices()¶

Returns:	tuple of all selected 1-based indices, or an empty tuple if there

is nothing selected

selectedItem()¶

Returns:	the first selected item, or None if nothing is selected

selectedItems()¶

Returns:	list of all selected items as strings, or an empty list if nothing

is selected

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

setItems(items)¶

Set the given items to be shown. :param items: iterable of items

if empty, the control will be empty after this call.

Returns:	self

setSelectedItem(item)¶

Set the given item selected, or clear the selection :param item: item to select, or clear the selection if None is given :note: it is not considered an error if the item doesnt exist - following

maya’s behaviour

Returns:	self

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.maya.ui.control.ToolCollection

class mrv.maya.ui.control.ToolCollection(*args, **kwargs)¶

Bases: mrv.maya.ui.RadioCollectionBase, mrv.maya.ui.NamedUI

Required for multiple inhertance

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(iterable) -> unicode

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_cia¶

p_collectionItemArray¶

p_dcm¶

p_disableCommands¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_gl¶

p_global¶

p_nci¶

p_numberOfCollectionItems¶

p_select¶

p_sl¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

`mrv.maya.ui.control`¶

Functions¶

Classes¶

Table Of Contents

Previous topic

Next topic

This Page

Navigation

mrv.maya.ui.control¶

Functions¶

Classes¶

Table Of Contents

Previous topic

Next topic

This Page

Quick search

Navigation

`mrv.maya.ui.control`¶