`mrv.maya.ui.editor`¶

Contains implementations of maya editors

Classes¶

Epydoc: mrv.maya.ui.editor.AnimCurveEditor

class mrv.maya.ui.editor.AnimCurveEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.AnimEditorBase

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

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

e_dcc¶: Event suitable to deal with user interface callback

e_denormalizeCurvesCommand¶: Event suitable to deal with user interface callback

e_ncc¶: Event suitable to deal with user interface callback

e_normalizeCurvesCommand¶: 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_af¶

p_autoFit¶

p_clipTime¶

p_control¶

p_cs¶

p_ct¶

p_ctl¶

p_curvesShown¶

p_dak¶

p_dat¶

p_di¶

p_displayActiveKeyTangents¶

p_displayActiveKeys¶

p_displayInfinities¶

p_displayKeys¶

p_displayTangents¶

p_dk¶

p_docTag¶

p_dtg¶

p_dtn¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_highlightConnection¶

p_hlc¶

p_la¶

p_lck¶

p_lockMainConnection¶

p_lookAt¶

p_mainListConnection¶

p_mlc¶

p_panel¶

p_pnl¶

p_resultScreenSamples¶

p_resultUpdate¶

p_rss¶

p_ru¶

p_s¶

p_sb¶

p_selectionConnection¶

p_showBufferCurves¶

p_showResults¶

p_slc¶

p_smoothness¶

p_snapTime¶

p_snapValue¶

p_sr¶

p_st¶

p_stateString¶

p_sts¶

p_sv¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.AnimEditorBase

class mrv.maya.ui.editor.AnimEditorBase(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

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_af¶

p_autoFit¶

p_control¶

p_ctl¶

p_dak¶

p_dat¶

p_di¶

p_displayActiveKeyTangents¶

p_displayActiveKeys¶

p_displayInfinities¶

p_displayKeys¶

p_displayTangents¶

p_dk¶

p_docTag¶

p_dtg¶

p_dtn¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_highlightConnection¶

p_hlc¶

p_la¶

p_lck¶

p_lockMainConnection¶

p_lookAt¶

p_mainListConnection¶

p_mlc¶

p_panel¶

p_pnl¶

p_selectionConnection¶

p_slc¶

p_snapTime¶

p_snapValue¶

p_st¶

p_stateString¶

p_sts¶

p_sv¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.BlendShapeEditor

class mrv.maya.ui.editor.BlendShapeEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

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_control¶

p_ctl¶

p_docTag¶

p_dtg¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_highlightConnection¶

p_hlc¶

p_lck¶

p_lockMainConnection¶

p_mainListConnection¶

p_mlc¶

p_panel¶

p_pnl¶

p_selectionConnection¶

p_slc¶

p_stateString¶

p_sts¶

p_targetControlList¶

p_targetList¶

p_tcl¶

p_tl¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

p_verticalSliders¶

p_vs¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.ClipEditor

class mrv.maya.ui.editor.ClipEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.AnimEditorBase

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

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

e_cd¶: Event suitable to deal with user interface callback

e_clipDropCmd¶: Event suitable to deal with user interface callback

e_dc¶: Event suitable to deal with user interface callback

e_deleteCmd¶: 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_af¶

p_allTrackHeights¶

p_autoFit¶

p_characterOutline¶

p_co¶

p_control¶

p_ctl¶

p_da¶

p_dak¶

p_dat¶

p_deselectAll¶

p_di¶

p_displayActiveKeyTangents¶

p_displayActiveKeys¶

p_displayInfinities¶

p_displayKeys¶

p_displayTangents¶

p_dk¶

p_docTag¶

p_dtg¶

p_dtn¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_fa¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_frameAll¶

p_hb¶

p_hc¶

p_highlightConnection¶

p_highlightedBlend¶

p_highlightedClip¶

p_hlc¶

p_la¶

p_lac¶

p_lc¶

p_lck¶

p_listAllCharacters¶

p_listCurrentCharacters¶

p_lockMainConnection¶

p_lookAt¶

p_mainListConnection¶

p_mc¶

p_menuContext¶

p_mlc¶

p_panel¶

p_pnl¶

p_sb¶

p_sc¶

p_selectBlend¶

p_selectClip¶

p_selectionConnection¶

p_slc¶

p_snapTime¶

p_snapValue¶

p_st¶

p_stateString¶

p_sts¶

p_sv¶

p_th¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.ColorEditor

class mrv.maya.ui.editor.ColorEditor(*args, **kwargs)¶

Bases: 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

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_a¶

p_alpha¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_hsv¶

p_hsvValue¶

p_r¶

p_result¶

p_rgb¶

p_rgbValue¶

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.editor.ComponentEditor

class mrv.maya.ui.editor.ComponentEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

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_control¶

p_ctl¶

p_docTag¶

p_dtg¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_ff¶

p_filter¶

p_floatField¶

p_floatSlider¶

p_fmc¶

p_forceMainConnection¶

p_fs¶

p_hidePathName¶

p_hideZeroColumns¶

p_highlightConnection¶

p_hlc¶

p_hpn¶

p_hzc¶

p_lck¶

p_li¶

p_lockInput¶

p_lockMainConnection¶

p_mainListConnection¶

p_mlc¶

p_newTab¶

p_nt¶

p_oc¶

p_ol¶

p_operationCount¶

p_operationLabels¶

p_operationType¶

p_ot¶

p_panel¶

p_pnl¶

p_pre¶

p_precision¶

p_removeTab¶

p_rt¶

p_sa¶

p_selected¶

p_selectionConnection¶

p_setOperationLabel¶

p_showObjects¶

p_showSelected¶

p_sl¶

p_slc¶

p_so¶

p_sol¶

p_sortAlpha¶

p_ss¶

p_stateString¶

p_sts¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.DeviceEditor

class mrv.maya.ui.editor.DeviceEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

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_control¶

p_ctl¶

p_docTag¶

p_dtg¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_highlightConnection¶

p_hlc¶

p_lck¶

p_lockMainConnection¶

p_mainListConnection¶

p_mlc¶

p_panel¶

p_pnl¶

p_selectionConnection¶

p_slc¶

p_stateString¶

p_sts¶

p_takePath¶

p_tp¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.DynPaintEditor

class mrv.maya.ui.editor.DynPaintEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.RenderEditorBase

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

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

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_activeOnly¶

p_ao¶

p_as¶

p_autoSave¶

p_cam¶

p_camera¶

p_canvasMode¶

p_canvasUndo¶

p_ccs¶

p_cl¶

p_clear¶

p_cm¶

p_control¶

p_ctl¶

p_cu¶

p_currentCanvasSize¶

p_dbf¶

p_dfg¶

p_di¶

p_displayAppearance¶

p_displayFog¶

p_displayImage¶

p_displayLights¶

p_displayStyle¶

p_displayTextures¶

p_docTag¶

p_doubleBuffer¶

p_drawContext¶

p_drc¶

p_dsa¶

p_dsl¶

p_dst¶

p_dtg¶

p_dtx¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_fil¶

p_fileName¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_highlightConnection¶

p_hlc¶

p_iconGrab¶

p_ig¶

p_lck¶

p_li¶

p_loadImage¶

p_lockMainConnection¶

p_mainListConnection¶

p_menu¶

p_mlc¶

p_mn¶

p_nbImages¶

p_newImage¶

p_ni¶

p_nim¶

p_pa¶

p_paintAll¶

p_panel¶

p_pnl¶

p_ra¶

p_redrawLast¶

p_refreshMode¶

p_removeAllImages¶

p_removeImage¶

p_ri¶

p_rig¶

p_rl¶

p_rmd¶

p_rollImage¶

p_sa¶

p_saveAlpha¶

p_saveBumpmap¶

p_saveImage¶

p_sb¶

p_sbf¶

p_sbm¶

p_scaleBlue¶

p_scaleGreen¶

p_scaleRed¶

p_selectionConnection¶

p_sg¶

p_si¶

p_singleBuffer¶

p_slc¶

p_snapShot¶

p_snp¶

p_sr¶

p_stateString¶

p_sts¶

p_tileSize¶

p_ts¶

p_uc¶

p_ulk¶

p_undoCache¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

p_wi¶

p_wr¶

p_wrap¶

p_writeImage¶

p_zm¶

p_zoom¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.EditorBase

class mrv.maya.ui.editor.EditorBase(*args, **kwargs)¶

Bases: mrv.maya.ui.NamedUI, mrv.maya.ui.util.UIContainerBase

Structural base for all Layouts allowing general queries and name handling Layouts may track their children

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

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

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_control¶

p_ctl¶

p_docTag¶

p_dtg¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_highlightConnection¶

p_hlc¶

p_lck¶

p_lockMainConnection¶

p_mainListConnection¶

p_mlc¶

p_panel¶

p_pnl¶

p_selectionConnection¶

p_slc¶

p_stateString¶

p_sts¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.GlRenderEditor

class mrv.maya.ui.editor.GlRenderEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

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_control¶

p_ctl¶

p_docTag¶

p_dtg¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_glRenderViewName¶

p_highlightConnection¶

p_hlc¶

p_lck¶

p_lockMainConnection¶

p_lookThru¶

p_lt¶

p_mainListConnection¶

p_mlc¶

p_modelViewName¶

p_panel¶

p_pnl¶

p_rvn¶

p_selectionConnection¶

p_slc¶

p_stateString¶

p_sts¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

p_vcn¶

p_viewCameraName¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.ItemFilter

class mrv.maya.ui.editor.ItemFilter(*args, **kwargs)¶: Bases: mrv.maya.ui.editor.ItemFilterBase

Epydoc: mrv.maya.ui.editor.ItemFilterAttr

class mrv.maya.ui.editor.ItemFilterAttr(*args, **kwargs)¶: Bases: mrv.maya.ui.editor.ItemFilterBase

Epydoc: mrv.maya.ui.editor.ItemFilterBase

class mrv.maya.ui.editor.ItemFilterBase(*args, **kwargs)¶: Bases: mrv.maya.ui.base.BaseUI

Epydoc: mrv.maya.ui.editor.ItemFilterRender

class mrv.maya.ui.editor.ItemFilterRender(*args, **kwargs)¶: Bases: mrv.maya.ui.editor.ItemFilterBase

Epydoc: mrv.maya.ui.editor.ModelEditor

class mrv.maya.ui.editor.ModelEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

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_activeOnly¶

p_activeView¶

p_addObjects¶

p_addSelected¶

p_allObjects¶

p_alo¶

p_ao¶

p_aob¶

p_as¶

p_av¶

p_backfaceCulling¶

p_bfc¶

p_bm¶

p_brz¶

p_bufferMode¶

p_bumpResolution¶

p_ca¶

p_cam¶

p_camera¶

p_cameraName¶

p_cameras¶

p_cm¶

p_cn¶

p_colorMap¶

p_colorResolution¶

p_control¶

p_controlVertices¶

p_cov¶

p_crz¶

p_ctl¶

p_cullingOverride¶

p_cv¶

p_da¶

p_dc¶

p_deformers¶

p_df¶

p_dim¶

p_dimensions¶

p_displayAppearance¶

p_displayLights¶

p_displayTextures¶

p_dl¶

p_docTag¶

p_dtg¶

p_dtx¶

p_dy¶

p_dynamicConstraints¶

p_dynamics¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_fcl¶

p_fdn¶

p_fen¶

p_fg¶

p_filter¶

p_fl¶

p_fluids¶

p_fmc¶

p_fmd¶

p_fo¶

p_fogColor¶

p_fogDensity¶

p_fogEnd¶

p_fogMode¶

p_fogSource¶

p_fogStart¶

p_fogging¶

p_follicles¶

p_forceMainConnection¶

p_fsc¶

p_fst¶

p_gr¶

p_grid¶

p_ha¶

p_hairSystems¶

p_handles¶

p_headsUpDisplay¶

p_highlightConnection¶

p_hlc¶

p_hs¶

p_hu¶

p_hud¶

p_hulls¶

p_i¶

p_ikHandles¶

p_ikh¶

p_interactive¶

p_ip¶

p_j¶

p_joints¶

p_lc¶

p_lck¶

p_lights¶

p_locators¶

p_lockMainConnection¶

p_lowQualityLighting¶

p_lql¶

p_lt¶

p_mainListConnection¶

p_manipulators¶

p_maxConstantTransparency¶

p_mct¶

p_mlc¶

p_mlocators¶

p_nCloths¶

p_nRigids¶

p_nc¶

p_ncl¶

p_noUndo¶

p_nr¶

p_ns¶

p_nud¶

p_nurbsCurves¶

p_nurbsSurfaces¶

p_occlusionCulling¶

p_ocl¶

p_panel¶

p_pivots¶

p_pl¶

p_planes¶

p_pm¶

p_pnl¶

p_polyMeshes¶

p_pv¶

p_rendererList¶

p_rendererListUI¶

p_rendererName¶

p_rls¶

p_rlu¶

p_rnm¶

p_sds¶

p_sdw¶

p_sel¶

p_selectionConnection¶

p_selectionHiliteDisplay¶

p_setSelected¶

p_shadows¶

p_slc¶

p_smoothWireframe¶

p_sortTransparent¶

p_ss¶

p_st¶

p_stateString¶

p_str¶

p_strokes¶

p_sts¶

p_subdivSurfaces¶

p_swf¶

p_ta¶

p_tal¶

p_td¶

p_textureAnisotropic¶

p_textureDisplay¶

p_textureHighlight¶

p_textureMaxSize¶

p_textureMemoryUsed¶

p_textureSampling¶

p_textures¶

p_th¶

p_tis¶

p_tms¶

p_tmu¶

p_transpInShadows¶

p_transparencyAlgorithm¶

p_ts¶

p_tsl¶

p_twoSidedLighting¶

p_tx¶

p_ubr¶

p_uci¶

p_ucm¶

p_udm¶

p_ui¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateColorMode¶

p_updateMainConnection¶

p_useBaseRenderer¶

p_useColorIndex¶

p_useDefaultMaterial¶

p_useInteractiveMode¶

p_useRGBImagePlane¶

p_viewObjects¶

p_viewSelected¶

p_vo¶

p_vs¶

p_wbs¶

p_wireframeBackingStore¶

p_wireframeOnShaded¶

p_wos¶

p_xr¶

p_xray¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.OutlinerEditor

class mrv.maya.ui.editor.OutlinerEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

e_sec¶: Event suitable to deal with user interface callback

e_selectCommand¶: 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_Obj¶

p_aao¶

p_aco¶

p_af¶

p_allowMultiSelection¶

p_alwaysToggleSelect¶

p_ams¶

p_as¶

p_atr¶

p_ats¶

p_attrAlphaOrder¶

p_attrFilter¶

p_autoExpand¶

p_autoSelectNewObjects¶

p_av¶

p_cmp¶

p_con¶

p_control¶

p_ctl¶

p_dag¶

p_dip¶

p_directSelect¶

p_displayMode¶

p_dm¶

p_dns¶

p_doNotSelectNewObjects¶

p_docTag¶

p_dropIsParent¶

p_ds¶

p_dtg¶

p_ean¶

p_editAttrName¶

p_eo¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_expandConnections¶

p_expandObjects¶

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_ha¶

p_highlightActive¶

p_highlightConnection¶

p_highlightSecondary¶

p_hir¶

p_hlc¶

p_hs¶

p_ics¶

p_ignoreDagHierarchy¶

p_isChildSelected¶

p_laf¶

p_lck¶

p_ln¶

p_lockMainConnection¶

p_longNames¶

p_mainListConnection¶

p_masterOutliner¶

p_mlc¶

p_mst¶

p_niceNames¶

p_nn¶

p_num¶

p_object¶

p_panel¶

p_pnl¶

p_sc¶

p_selectionConnection¶

p_setFilter¶

p_setsIgnoreFilters¶

p_sf¶

p_showAnimCurvesOnly¶

p_showAttrValues¶

p_showAttributes¶

p_showCompounds¶

p_showConnected¶

p_showDagOnly¶

p_showLeafs¶

p_showNamespace¶

p_showNumericAttrsOnly¶

p_showSelected¶

p_showSetMembers¶

p_showShapes¶

p_showTextureNodesOnly¶

p_showUVAttrsOnly¶

p_showUnitlessCurves¶

p_shp¶

p_sif¶

p_slc¶

p_sn¶

p_so¶

p_sortOrder¶

p_ssm¶

p_stateString¶

p_sts¶

p_su¶

p_tf¶

p_tno¶

p_transmitFilters¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

p_uv¶

p_xc¶

p_xpd¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.RenderEditorBase

class mrv.maya.ui.editor.RenderEditorBase(*args, **kwargs)¶

Bases: mrv.maya.ui.EditorBase

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

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

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_control¶

p_ctl¶

p_dbf¶

p_di¶

p_displayImage¶

p_displayStyle¶

p_docTag¶

p_doubleBuffer¶

p_dst¶

p_dtg¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_highlightConnection¶

p_hlc¶

p_lck¶

p_li¶

p_loadImage¶

p_lockMainConnection¶

p_mainListConnection¶

p_mlc¶

p_nbImages¶

p_nim¶

p_panel¶

p_pnl¶

p_ra¶

p_removeAllImages¶

p_removeImage¶

p_ri¶

p_saveImage¶

p_sb¶

p_sbf¶

p_scaleBlue¶

p_scaleGreen¶

p_scaleRed¶

p_selectionConnection¶

p_sg¶

p_si¶

p_singleBuffer¶

p_slc¶

p_sr¶

p_stateString¶

p_sts¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

p_wi¶

p_writeImage¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.RenderWindowEditor

class mrv.maya.ui.editor.RenderWindowEditor(*args, **kwargs)¶

Bases: mrv.maya.ui.RenderEditorBase

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

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

e_cc¶: Event suitable to deal with user interface callback

e_changedCommand¶: 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_ar¶

p_autoResize¶

p_blendMode¶

p_blm¶

p_cap¶

p_caption¶

p_cd¶

p_cl¶

p_clear¶

p_compDisplay¶

p_compImageFile¶

p_control¶

p_crc¶

p_ctl¶

p_currentCamera¶

p_dbf¶

p_di¶

p_displayImage¶

p_displayStyle¶

p_docTag¶

p_doubleBuffer¶

p_dst¶

p_dtg¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_fi¶

p_filter¶

p_fmc¶

p_forceMainConnection¶

p_fr¶

p_frameImage¶

p_frameRegion¶

p_highlightConnection¶

p_hlc¶

p_lck¶

p_li¶

p_loadImage¶

p_lockMainConnection¶

p_mainListConnection¶

p_marquee¶

p_mlc¶

p_mq¶

p_nbImages¶

p_nim¶

p_panel¶

p_pca¶

p_pcaption¶

p_pnl¶

p_ra¶

p_realSize¶

p_removeAllImages¶

p_removeImage¶

p_resetRegion¶

p_ri¶

p_rr¶

p_rs¶

p_saveImage¶

p_sb¶

p_sbf¶

p_scaleBlue¶

p_scaleGreen¶

p_scaleRed¶

p_selectionConnection¶

p_sg¶

p_showRegion¶

p_si¶

p_singleBuffer¶

p_slc¶

p_snapshot¶

p_snp¶

p_sr¶

p_srg¶

p_stateString¶

p_sts¶

p_tgl¶

p_toggle¶

p_ulk¶

p_unlockMainConnection¶

p_upd¶

p_updateMainConnection¶

p_wi¶

p_writeImage¶

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.

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()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

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.editor.SelectionConnection

class mrv.maya.ui.editor.SelectionConnection(*args, **kwargs)¶

Bases: 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

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

e_addScript¶: Event suitable to deal with user interface callback

e_as¶: Event suitable to deal with user interface callback

e_removeScript¶: Event suitable to deal with user interface callback

e_rs¶: 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_addTo¶

p_addremove¶

p_clear¶

p_clr¶

p_connectionList¶

p_d¶

p_deselect¶

p_ed¶

p_editor¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_f¶

p_filter¶

p_findObject¶

p_fo¶

p_g¶

p_global¶

p_id¶

p_identify¶

p_lck¶

p_lock¶

p_lst¶

p_obj¶

p_object¶

p_rm¶

p_s¶

p_select¶

p_sw¶

p_switch¶

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.editor`¶

Classes¶

Table Of Contents

Previous topic

Next topic

This Page

Navigation

mrv.maya.ui.editor¶

Classes¶

Table Of Contents

Previous topic

Next topic

This Page

Quick search

Navigation

`mrv.maya.ui.editor`¶