pymel.core.uitypes.PalettePort

Inheritance diagram of PalettePort

class PalettePort

class counterpart of mel function palettePort

This command creates an array of color cells. It could be used to to store an retrieve some colors you want to manage during your working session.

changeCommand(val=True, **kwargs)

This command string will be executed when a color in the palette is changed.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.palettePort

colorEdited(val=True, **kwargs)

This command string will be executed when a color in the palette is edited.

Derived from mel command maya.cmds.palettePort

dragCallback(val=True, **kwargs)

Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys “dragControl”, “x”, “y”, “modifiers”. The “dragControl” value is a string and the other values are integers (eg the callback string could be “print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’”)

Derived from mel command maya.cmds.palettePort

dropCallback(val=True, **kwargs)

Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys “dragControl”, “dropControl”, “messages”, “x”, “y”, “type”. The “dragControl” value is a string and the other values are integers (eg the callback string could be “print ‘%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d’”)

Derived from mel command maya.cmds.palettePort

getActualTotal(**kwargs)

Set the actual number of palette entries. This number must be greater than zero, but not be greater than maximum number of palette entries defined by the dimensionsflag.

Derived from mel command maya.cmds.palettePort

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.palettePort

getBackgroundColor(**kwargs)

The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.

Derived from mel command maya.cmds.palettePort

getColorEditable(**kwargs)

If true then the user can modify the current index’s color.

Derived from mel command maya.cmds.palettePort

getDimensions(**kwargs)

Set the dimensions of the array.

Derived from mel command maya.cmds.palettePort

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.palettePort

getEditable(**kwargs)

If true then the user can change the current color.

Derived from mel command maya.cmds.palettePort

getEnable(**kwargs)

The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.

Derived from mel command maya.cmds.palettePort

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.palettePort

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.palettePort

getHeight(**kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.palettePort

getHsvValue(**kwargs)

Set a color for a given cell, using HSV format. On query return the color of the current cell.

Derived from mel command maya.cmds.palettePort

getIsObscured(**kwargs)

Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control’s window is invisible or iconified.

Derived from mel command maya.cmds.palettePort

getManage(**kwargs)

Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.

Derived from mel command maya.cmds.palettePort

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.palettePort

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.palettePort

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.palettePort

getRgbValue(**kwargs)

Set a color for a given cell, using RGB format. On query return the color of the current cell.

Derived from mel command maya.cmds.palettePort

getSetCurCell(**kwargs)

Set the current cell in the array to the given index. Returns the current cell when queried.

Derived from mel command maya.cmds.palettePort

getTransparent(**kwargs)

Set a given cell to be the transparent color. A cell value of -1 indicates that no cell is transparent. On query returns the current transparent cell.

Derived from mel command maya.cmds.palettePort

getVisible(**kwargs)

The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).

Derived from mel command maya.cmds.palettePort

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.palettePort

getWidth(**kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.palettePort

redraw(val=True, **kwargs)

Forces a redraw of the array

Derived from mel command maya.cmds.palettePort

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.palettePort

setBackgroundColor(val=True, **kwargs)

The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.

Derived from mel command maya.cmds.palettePort

setColorEditable(val=True, **kwargs)

If true then the user can modify the current index’s color.

Derived from mel command maya.cmds.palettePort

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.palettePort

setEditable(val=True, **kwargs)

If true then the user can change the current color.

Derived from mel command maya.cmds.palettePort

setEnable(val=True, **kwargs)

The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.

Derived from mel command maya.cmds.palettePort

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.palettePort

setHeight(val=True, **kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.palettePort

setHsvValue(val=True, **kwargs)

Set a color for a given cell, using HSV format. On query return the color of the current cell.

Derived from mel command maya.cmds.palettePort

setManage(val=True, **kwargs)

Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.

Derived from mel command maya.cmds.palettePort

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.palettePort

setRgbValue(val=True, **kwargs)

Set a color for a given cell, using RGB format. On query return the color of the current cell.

Derived from mel command maya.cmds.palettePort

setSetCurCell(val=True, **kwargs)

Set the current cell in the array to the given index. Returns the current cell when queried.

Derived from mel command maya.cmds.palettePort

setTransparent(val=True, **kwargs)

Set a given cell to be the transparent color. A cell value of -1 indicates that no cell is transparent. On query returns the current transparent cell.

Derived from mel command maya.cmds.palettePort

setVisible(val=True, **kwargs)

The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).

Derived from mel command maya.cmds.palettePort

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.palettePort

setWidth(val=True, **kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.palettePort

Previous topic

pymel.core.uitypes.OutlinerPanel

Next topic

pymel.core.uitypes.PaneLayout

Core

Core Modules

Other Modules

This Page