mrv.maya.ui.layout

Epydoc: mrv.maya.ui.layout

Contains the most important mel-layouts wrapped into easy to use python classes These are specialized and thus more powerful than the default wraps

Classes

Epydoc: mrv.maya.ui.layout.ColumnLayout

class mrv.maya.ui.layout.ColumnLayout(*args, **kwargs)

Bases: mrv.maya.ui.ColumnLayoutBase

Wrapper class for a simple column layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_adj

p_adjustableColumn

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_cal

p_cat

p_childArray

Returns:children of this layout

p_co

p_columnAlign

p_columnAttach

p_columnOffset

p_columnWidth

p_cw

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_m

p_manage

p_nch

p_npm

p_numberOfChildren

p_numberOfPopupMenus

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_rowSpacing

p_rs

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.ColumnLayoutBase

class mrv.maya.ui.layout.ColumnLayoutBase(*args, **kwargs)

Bases: mrv.maya.ui.Layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_cal

p_cat

p_childArray

Returns:children of this layout

p_co

p_columnAlign

p_columnAttach

p_columnOffset

p_columnWidth

p_cw

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_m

p_manage

p_nch

p_npm

p_numberOfChildren

p_numberOfPopupMenus

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_rowSpacing

p_rs

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.FormLayout

class mrv.maya.ui.layout.FormLayout(*args, **kwargs)

Bases: mrv.maya.ui.Layout

Wrapper class for maya form layout

class FormConstraint

Bases: object

defines the way a child is constrained, possibly to other children

Todo:proper constraint system, but could be complicated to make it really easy to use

classmethod FormLayout.activeParent()

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

FormLayout.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 FormLayout.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

FormLayout.annotation()

:return : the annotation string

FormLayout.basename()

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

FormLayout.capitalize

S.capitalize() -> unicode

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

FormLayout.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)

FormLayout.childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

FormLayout.children()

Returns:children of this layout

FormLayout.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

FormLayout.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

FormLayout.clearChildren()

Clear our child arrays to quickly forget about our children

FormLayout.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.

FormLayout.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.

FormLayout.delete()

Delete this UI - the wrapper instance must not be used after this call

FormLayout.deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

FormLayout.dimension()

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

FormLayout.e_dgc

Event suitable to deal with user interface callback

FormLayout.e_dpc

Event suitable to deal with user interface callback

FormLayout.e_dragCallback

Event suitable to deal with user interface callback

FormLayout.e_dropCallback

Event suitable to deal with user interface callback

FormLayout.e_vcc

Event suitable to deal with user interface callback

FormLayout.e_visibleChangeCommand

Event suitable to deal with user interface callback

FormLayout.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.

FormLayout.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.

FormLayout.exists()

Returns:True if this instance still exists in maya

FormLayout.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.

FormLayout.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.

FormLayout.format

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

FormLayout.fullChildName(childname)

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

FormLayout.index

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

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

FormLayout.isPartOf(other)

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

FormLayout.isRoot()

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

FormLayout.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

FormLayout.isalnum

S.isalnum() -> bool

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

FormLayout.isalpha

S.isalpha() -> bool

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

FormLayout.isdecimal

S.isdecimal() -> bool

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

FormLayout.isdigit

S.isdigit() -> bool

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

FormLayout.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.

FormLayout.isnumeric

S.isnumeric() -> bool

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

FormLayout.isspace

S.isspace() -> bool

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

FormLayout.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.

FormLayout.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.

FormLayout.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

FormLayout.join

S.join(iterable) -> unicode

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

FormLayout.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 FormLayout.listEventNames()

Returns:list of event ids that exist on our class

FormLayout.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).

FormLayout.lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

FormLayout.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

FormLayout.p_ann

:return : the annotation string

FormLayout.p_annotation

:return : the annotation string

FormLayout.p_backgroundColor

FormLayout.p_bgc

FormLayout.p_ca

Returns:children of this layout

FormLayout.p_childArray

Returns:children of this layout

FormLayout.p_defineTemplate

FormLayout.p_dimension

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

FormLayout.p_doctTag

FormLayout.p_dt

FormLayout.p_dtg

FormLayout.p_ebg

FormLayout.p_en

FormLayout.p_enable

FormLayout.p_enableBackground

FormLayout.p_ex

Returns:True if this instance still exists in maya

FormLayout.p_exists

Returns:True if this instance still exists in maya

FormLayout.p_fpn

FormLayout.p_fullPathName

FormLayout.p_h

FormLayout.p_height

FormLayout.p_io

FormLayout.p_isObscured

FormLayout.p_m

FormLayout.p_manage

FormLayout.p_nch

FormLayout.p_npm

FormLayout.p_numberOfChildren

FormLayout.p_numberOfPopupMenus

FormLayout.p_pma

Returns:popup menus attached to this control

FormLayout.p_po

FormLayout.p_popupMenuArray

Returns:popup menus attached to this control

FormLayout.p_preventOverride

FormLayout.p_useTemplate

FormLayout.p_ut

FormLayout.p_vis

FormLayout.p_visible

FormLayout.p_w

FormLayout.p_width

FormLayout.parent()

Returns:parent instance of this ui element

FormLayout.parentDeep()

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

FormLayout.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.

FormLayout.popupMenuArray()

Returns:popup menus attached to this control

FormLayout.removeChild(child)

Remove the given child from our list

Returns:True if the child was found and has been removed, False otherwise

FormLayout.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.

FormLayout.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.

FormLayout.rindex

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

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

FormLayout.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).

FormLayout.root()

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

FormLayout.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.

FormLayout.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.

FormLayout.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

FormLayout.sender()

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

FormLayout.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 !

FormLayout.setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

FormLayout.setDimension(dimension)

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

FormLayout.setFocus()

Set the global keyboard focus to this control

FormLayout.setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

FormLayout.setup(**kwargs)

Apply the given setup to the form layout, specified using kwargs

Parameter:kwargs – arguments you would set use to setup the form layout

FormLayout.shortName()

Returns:shortname of the ui ( name without pipes )

FormLayout.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.

FormLayout.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.

FormLayout.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.

FormLayout.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

FormLayout.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

FormLayout.swapcase

S.swapcase() -> unicode

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

FormLayout.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.

FormLayout.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.

FormLayout.type()

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

FormLayout.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.

FormLayout.upper

S.upper() -> unicode

Return a copy of S converted to uppercase.

FormLayout.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.layout.FrameLayout

class mrv.maya.ui.layout.FrameLayout(*args, **kwargs)

Bases: mrv.maya.ui.Layout

Simple wrapper for a frame layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_cc

Event suitable to deal with user interface callback

e_collapseCommand

Event suitable to deal with user interface callback

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_ec

Event suitable to deal with user interface callback

e_expandCommand

Event suitable to deal with user interface callback

e_pcc

Event suitable to deal with user interface callback

e_pec

Event suitable to deal with user interface callback

e_preCollapseCommand

Event suitable to deal with user interface callback

e_preExpandCommand

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_borderStyle

p_borderVisible

p_bs

p_bw

p_ca

Returns:children of this layout

p_childArray

Returns:children of this layout

p_cl

p_cll

p_collapsable

p_collapse

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fn

p_font

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_l

p_la

p_label

p_labelAlign

p_labelIndent

p_labelVisible

p_labelWidth

p_li

p_lv

p_lw

p_m

p_manage

p_marginHeight

p_marginWidth

p_mh

p_mw

p_nch

p_npm

p_numberOfChildren

p_numberOfPopupMenus

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.Layout

class mrv.maya.ui.layout.Layout(*args, **kwargs)

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

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

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_childArray

Returns:children of this layout

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_m

p_manage

p_nch

p_npm

p_numberOfChildren

p_numberOfPopupMenus

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.PaneLayout

class mrv.maya.ui.layout.PaneLayout(*args, **kwargs)

Bases: mrv.maya.ui.Layout

Simple wrapper for a pane layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_separatorMovedCommand

Event suitable to deal with user interface callback

e_smc

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_activeFrameThickness

p_activePane

p_activePaneIndex

p_aft

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_ap

p_api

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_childArray

Returns:children of this layout

p_cn

p_configuration

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_m

p_manage

p_nch

p_npm

p_numberOfChildren

p_numberOfPopupMenus

p_numberOfVisiblePanes

p_nvp

p_p1

p_p2

p_p3

p_p4

p_pane1

p_pane2

p_pane3

p_pane4

p_paneSize

p_paneUnderPointer

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_ps

p_pup

p_separatorThickness

p_setPane

p_shp

p_sp

p_st

p_staticHeightPane

p_staticWidthPane

p_swp

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.RowColumnLayout

class mrv.maya.ui.layout.RowColumnLayout(*args, **kwargs)

Bases: mrv.maya.ui.ColumnLayoutBase

Wrapper for row column layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_cal

p_cat

p_childArray

Returns:children of this layout

p_co

p_columnAlign

p_columnAttach

p_columnOffset

p_columnWidth

p_cw

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_m

p_manage

p_nc

p_nch

p_npm

p_nr

p_numberOfChildren

p_numberOfColumns

p_numberOfPopupMenus

p_numberOfRows

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_rh

p_ro

p_rowHeight

p_rowOffset

p_rowSpacing

p_rs

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.RowLayout

class mrv.maya.ui.layout.RowLayout(*args, **kwargs)

Bases: mrv.maya.ui.Layout

Wrapper for row column layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_ad1

p_ad2

p_ad3

p_ad4

p_ad5

p_ad6

p_adj

p_adjustableColumn

p_adjustableColumn1

p_adjustableColumn2

p_adjustableColumn3

p_adjustableColumn4

p_adjustableColumn5

p_adjustableColumn6

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_cal

p_cat

p_childArray

Returns:children of this layout

p_cl1

p_cl2

p_cl3

p_cl4

p_cl5

p_cl6

p_co1

p_co2

p_co3

p_co4

p_co5

p_co6

p_columnAlign

p_columnAlign1

p_columnAlign2

p_columnAlign3

p_columnAlign4

p_columnAlign5

p_columnAlign6

p_columnAttach

p_columnAttach1

p_columnAttach2

p_columnAttach3

p_columnAttach4

p_columnAttach5

p_columnAttach6

p_columnOffset1

p_columnOffset2

p_columnOffset3

p_columnOffset4

p_columnOffset5

p_columnOffset6

p_columnWidth

p_columnWidth1

p_columnWidth2

p_columnWidth3

p_columnWidth4

p_columnWidth5

p_columnWidth6

p_ct1

p_ct2

p_ct3

p_ct4

p_ct5

p_ct6

p_cw

p_cw1

p_cw2

p_cw3

p_cw4

p_cw5

p_cw6

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_m

p_manage

p_nc

p_nch

p_npm

p_numberOfChildren

p_numberOfColumns

p_numberOfPopupMenus

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_rat

p_rowAttach

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.ScrollLayout

class mrv.maya.ui.layout.ScrollLayout(*args, **kwargs)

Bases: mrv.maya.ui.Layout

Wrapper for a scroll layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_dgc

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_childArray

Returns:children of this layout

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_io

p_isObscured

p_m

p_manage

p_mcw

p_minChildWidth

p_nch

p_npm

p_numberOfChildren

p_numberOfPopupMenus

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_sah

p_sav

p_saw

p_sbp

p_scrollAreaHeight

p_scrollAreaValue

p_scrollAreaWIdth

p_scrollByPixel

p_scrollPage

p_sp

p_useTemplate

p_ut

p_vis

p_visible

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

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

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.layout.TabLayout

class mrv.maya.ui.layout.TabLayout(*args, **kwargs)

Bases: mrv.maya.ui.Layout

Simple wrapper for a tab layout

classmethod activeParent()

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

add(child, set_self_active=False, revert_to_previous_parent=True)

Add the given child UI item to our list of children

Parameters:

• set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements
• revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True

Returns:

the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

annotation()

:return : the annotation string

basename()

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

capitalize

S.capitalize() -> unicode

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

center

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

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

childByName(childname)

Returns:stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) Raises KeyError:  if a child with that name does not exist

children()

Returns:children of this layout

childrenDeep(**kwargs)

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

clearAllEvents()

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

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

clearChildren()

Clear our child arrays to quickly forget about our children

count

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

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

decode

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

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

delete()

Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)

Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()

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

e_cc

Event suitable to deal with user interface callback

e_changeCommand

Event suitable to deal with user interface callback

e_dcc

Event suitable to deal with user interface callback

e_dgc

Event suitable to deal with user interface callback

e_doubleClickCommand

Event suitable to deal with user interface callback

e_dpc

Event suitable to deal with user interface callback

e_dragCallback

Event suitable to deal with user interface callback

e_dropCallback

Event suitable to deal with user interface callback

e_preSelectCommand

Event suitable to deal with user interface callback

e_psc

Event suitable to deal with user interface callback

e_sc

Event suitable to deal with user interface callback

e_selectCommand

Event suitable to deal with user interface callback

e_vcc

Event suitable to deal with user interface callback

e_visibleChangeCommand

Event suitable to deal with user interface callback

encode

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

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

endswith

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

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

exists()

Returns:True if this instance still exists in maya

expandtabs

S.expandtabs([tabsize]) -> unicode

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

find

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

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

Return -1 on failure.

format

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

fullChildName(childname)

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

index

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

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

isPartOf(other)

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

isRoot()

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

isRootOf(other)

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

isalnum

S.isalnum() -> bool

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

isalpha

S.isalpha() -> bool

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

isdecimal

S.isdecimal() -> bool

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

isdigit

S.isdigit() -> bool

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

islower

S.islower() -> bool

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

isnumeric

S.isnumeric() -> bool

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

isspace

S.isspace() -> bool

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

istitle

S.istitle() -> bool

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

isupper

S.isupper() -> bool

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

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

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

join

S.join(iterable) -> unicode

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

listChildren(predicate=<function <lambda> at 0x6063578>)

Returns:list with our child instances Parameter:predicate – function returning True for each child to include in result, allows to easily filter children Note:it’s a copy, so you can freely act on the list Note:children will be returned in the order in which they have been added

classmethod listEventNames()

Returns:list of event ids that exist on our class

ljust

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

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

lower

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip

S.lstrip([chars]) -> unicode

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

p_ann

:return : the annotation string

p_annotation

:return : the annotation string

p_backgroundColor

p_bgc

p_ca

Returns:children of this layout

p_childArray

Returns:children of this layout

p_childResizable

p_cr

p_defineTemplate

p_dimension

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

p_doctTag

p_dt

p_dtg

p_ebg

p_en

p_enable

p_enableBackground

p_ex

Returns:True if this instance still exists in maya

p_exists

Returns:True if this instance still exists in maya

p_fpn

p_fullPathName

p_h

p_height

p_horizontalScrollBarThickness

p_hst

p_i

p_image

p_imageVisible

p_imh

p_imw

p_innerMarginHeight

p_innerMarginWidth

p_io

p_isObscured

p_iv

p_m

p_manage

p_mcw

p_minChildWidth

p_moveTab

p_mt

p_nch

p_npm

p_numberOfChildren

p_numberOfPopupMenus

p_pma

Returns:popup menus attached to this control

p_po

p_popupMenuArray

Returns:popup menus attached to this control

p_preventOverride

p_scr

p_scrollable

p_selectTab

p_selectTabIndex

p_st

p_sti

p_tabLabel

p_tabLabelIndex

p_tabsVisible

p_tl

p_tli

p_tv

p_useTemplate

p_ut

p_verticalScrollBarThickness

p_vis

p_visible

p_vst

p_w

p_width

parent()

Returns:parent instance of this ui element

parentDeep()

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

partition

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

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

popupMenuArray()

Returns:popup menus attached to this control

removeChild(child)

Remove the given child from our list

Returns:True if the child was found and has been removed, False otherwise

replace

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

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

rfind

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

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

Return -1 on failure.

rindex

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

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

rjust

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

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

root()

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

rpartition

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

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

rsplit

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

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

rstrip

S.rstrip([chars]) -> unicode

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

sender()

Returns:instance which sent the event you are currently processing Raises ValueError:  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 !

setAnnotation(ann)

Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)

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

setFocus()

Set the global keyboard focus to this control

setParentActive()

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:self Note:can safely be called several times

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.