nodeIconButton is undoable, queryable, and editable.
This control supports up to 3 icon images and 4 different display
styles. The icon image displayed is the one that best fits the
current size of the control given its current style. This command
creates a button that can be displayed with different icons, with
or without a text label. If the button is drag and dropped onto
other controls (e.g., HyperShade), the command will be executed and
the return string will be used as the name of a dropped node.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-exists(-ex) |
|
|
|
Returns true|false depending upon whether the specified object
exists. Other flags are ignored. |
|
-defineTemplate(-dt) |
string |
|
|
Puts a command in a mode where any other flags and args are
parsed and added to the command template specified in the argument.
They will be used as default arguments in any subsequent
invocations of the command when templateName is set as the current
template. |
|
-useTemplate(-ut) |
string |
|
|
Force the command to use a command template other than the
current one. |
|
-parent(-p) |
string |
|
|
The parent layout for this control. |
|
-enable(-en) |
boolean |
|
|
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. |
|
-width(-w) |
int |
|
|
The width of the control. The control will attempt to be this
size if it is not overruled by parent layout conditions. |
|
-height(-h) |
int |
|
|
The height of the control. The control will attempt to be this
size if it is not overruled by parent layout conditions. |
|
-visible(-vis) |
boolean |
|
|
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). |
|
-visibleChangeCommand(-vcc) |
script |
|
|
Command that gets executed when visible state of the control
changes. |
|
-isObscured(-io) |
|
|
|
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. |
|
-manage(-m) |
boolean |
|
|
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. |
|
|
|
|
|
Return the number of popup menus attached to this control. |
|
|
|
|
|
Return the names of all the popup menus attached to this
control. |
|
-preventOverride(-po) |
boolean |
|
|
If true, this flag disallows overriding the control's attribute
via the control's right mouse button menu. |
|
-annotation(-ann) |
string |
|
|
Annotate the control with an extra string value. |
|
-backgroundColor(-bgc) |
float float float |
|
|
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. |
|
-enableBackground(-ebg) |
boolean |
|
|
Enables the background color of the control. |
|
-docTag(-dtg) |
string |
|
|
Add a documentation flag to the control. The documentation flag
has a directory structure like hierarchy. Eg. -dt
render/multiLister/createNode/material |
|
-dragCallback(-dgc) |
script |
|
|
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'") |
|
-dropCallback(-dpc) |
script |
|
|
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'") |
|
-fullPathName(-fpn) |
string |
|
|
Return the full path name of the widget, which includes all the
parents |
|
-image1(-i1) |
string |
|
|
-image2(-i2) |
string |
|
|
-image3(-i3) |
string |
|
|
This control supports three icons. The icon that best fits the
current size of the control will be displayed. |
|
-image(-i) |
string |
|
|
If you are not providing images with different sizes then you
may use this flag for the control's image. If the "iconOnly" style
is set, the icon will be scaled to the size of the control. |
|
-disabledImage(-di) |
string |
|
|
Image used when the button is disabled. Image size must be the
same as the image specified with the i/image flag. This is a
Windows only flag. |
|
-imageOverlayLabel(-iol) |
string |
|
|
A short string, up to 5 characters, representing a label that
will be displayed on top of the image. |
|
-overlayLabelColor(-olc) |
float float float |
|
|
The RGB color of the label defined by imageOverlayLabel.
Default is a light grey: .8 .8 .8 |
|
-overlayLabelBackColor(-olb) |
float float float float |
|
|
The RGBA color of the shadow behind the label defined by
imageOverlayLabel. Default is 25% transparent black: 0 0 0 .25 |
|
-label(-l) |
string |
|
|
The text that appears in the control. |
|
-style(-st) |
string |
|
|
The draw style of the control. Valid styles are "iconOnly",
"textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and
"iconAndTextCentered". (Note: "iconAndTextCentered" is only
available on Windows). If the "iconOnly" style is set, the icon
will be scaled to the size of the control. |
|
-align(-al) |
string |
|
|
The label alignment. Alignment values are "left", "right", and
"center". By default, the label is aligned "center". Currently only
available when -st/style is set to "iconAndTextCentered". |
|
-labelOffset(-lo) |
int |
|
|
The label offset. Default is 0. Currently only available when
-st/style is set to "iconAndTextCentered". |
|
-marginWidth(-mw) |
uint |
|
|
The number of pixels on either side of the control content. The
default value is 1 pixel. |
|
-marginHeight(-mh) |
uint |
|
|
The number of pixels above and below the control content. The
default value is 1 pixel. |
|
-font(-fn) |
string |
|
|
The font for the text. Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont",
"smallPlainLabelFont", "obliqueLabelFont", "smallObliqueLabelFont",
"fixedWidthFont" and "smallFixedWidthFont". |
|
-command(-c) |
script |
|
|
Command executed when the control is pressed. The command
should return a string which will be used to facilitate node drag
and drop. |
|