Contains implementations of maya editors
Epydoc: mrv.maya.ui.panel.Panel
Bases: mrv.maya.ui.NamedUI, mrv.maya.ui.util.UIContainerBase
Structural base for all Layouts allowing general queries and name handling Layouts may track their children
| Returns: | NameUI of the currently set parent |
|---|---|
| Raises RuntimeError: | |
| if no active parent was set | |
Add the given child UI item to our list of children
| Parameters: |
|
|---|---|
| Returns: | the newly added child, allowing contructs like button = layout.addChild( Button( ) ) |
| Returns: | item with separator added to it ( just once ) |
|---|---|
| Note: | operates best on strings |
| Parameters: |
|
| Returns: | basename of this path, ‘/hello/world’ -> ‘world’ |
|---|
S.capitalize() -> unicode
Return a capitalized version of S, i.e. make the first character have upper case.
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)
| 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 | |
| Returns: | all intermediate child instances |
|---|---|
| Note: | the order of children is lexically ordered at this time |
| Note: | this implementation is slow and should be overridden by more specialized subclasses |
| 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 |
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 |
|---|
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.
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.
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.
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.
| Returns: | True if this instance still exists in maya |
|---|
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.
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.
S.index(sub [,start [,end]]) -> int
Like S.find() but raise ValueError when the substring is not found.
| Returns: | True if self is a part of other, and thus can be found in other |
|---|---|
| Note: | operates on strings only |
| Returns: | True if this path is the root of the DAG |
|---|
| Returns: | True other starts with self |
|---|---|
| Note: | operates on strings |
| Note: | we assume other has the same type as self, thus the same separator |
S.isalnum() -> bool
Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.
S.isalpha() -> bool
Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.
S.isdecimal() -> bool
Return True if there are only decimal characters in S, False otherwise.
S.isdigit() -> bool
Return True if all characters in S are digits and there is at least one character in S, False otherwise.
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.
S.isnumeric() -> bool
Return True if there are only numeric characters in S, False otherwise.
S.isspace() -> bool
Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.
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.
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.
| Returns: | generator retrieving all parents up to the root |
|---|---|
| Parameter: | predicate – returns True for all x that you want to be returned |
S.join(iterable) -> unicode
Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.
| 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 |
| Returns: | list of event ids that exist on our class |
|---|
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).
S.lower() -> unicode
Return a copy of the string S converted to lowercase.
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
| Returns: | True if this instance still exists in maya |
|---|
| Returns: | True if this instance still exists in maya |
|---|
| Returns: | parent instance of this ui element |
|---|
| Returns: | all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ] |
|---|
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.
Remove the given child from our list
| Returns: | True if the child was found and has been removed, False otherwise |
|---|
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.
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.
S.rindex(sub [,start [,end]]) -> int
Like S.rfind() but raise ValueError when the substring is not found.
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).
| Returns: | the root of the DAG - it has no further parents |
|---|
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.
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.
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
| Returns: | instance which sent the event you are currently processing |
|---|---|
| Raises ValueError: | |
| if no event is currently in progress | |
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 ! |
| Returns: | shortname of the ui ( name without pipes ) |
|---|
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.
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.
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.
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
| 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 |
S.swapcase() -> unicode
Return a copy of S with uppercase characters converted to lowercase and vice versa.
S.title() -> unicode
Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.
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.
| Returns: | the python class able to create this class |
|---|---|
| Note: | The return value is NOT the type string, but a class |
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. |
|---|
S.upper() -> unicode
Return a copy of S converted to uppercase.
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.