mrv.maya.ui.browse.option

Epydoc: mrv.maya.ui.browse.option

module with option implementations, to be shown in finder layouts

Classes

Epydoc: mrv.maya.ui.browse.option.FileOpenOptions

class mrv.maya.ui.browse.option.FileOpenOptions

Bases: mrv.maya.ui.ColumnLayout, mrv.maya.ui.browse.interface.iOptions

Options implementation providing options useful during file-open

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.

fileOptions()

Returns:dict with keyword options reflecting the settings of the

interface. These should be given to the file command

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.browse.option

class mrv.maya.ui.browse.option.iOptions

Bases: mrv.interface.Interface

Interface for all custom options layouts to be used with the FinderLayout. They take a weak-reference to their parent FinderLayout allowing them to set themselves up if necessary. The options they represent must be read by a custom implementation of the FinderLayout

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

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

basename()

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

children(predicate=<function <lambda> at 0x7f41dd7c2ed8>)

Returns:list of intermediate children of path, [ child1 , child2 ] Parameter:predicate – return True to include x in result Note:the child objects returned are supposed to be valid paths, not just relative paths

childrenDeep(order=1, predicate=<function <lambda> at 0x7f41dd7c5050>)

Returns:

list of all children of path, [ child1 , child2 ]

Parameters:

• order – order enumeration
• predicate – returns true if x may be returned

Note:

the child objects returned are supposed to be valid paths, not just relative paths

fullChildName(childname)

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

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

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

parent()

Returns:parent of this path, ‘/hello/world’ -> ‘/hello’ or None if this path is the dag’s root

parentDeep()

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

root()

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

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