Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

webBrowser [-annotation string] [-back] [-backgroundColor float float float] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-enable boolean] [-exists] [-find string] [-forward] [-height int] [-home] [-isObscured] [-manage boolean] [-matchCase boolean] [-numberOfPopupMenus] [-openURL string] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-reload] [-searchForward boolean] [-stop] [-urlChangedCb string] [-useTemplate string] [-visible boolean] [-width int] [-wrap boolean] [string]

webBrowser is undoable, queryable, and editable.

This command is obsolete and will be removed in next version of Maya. The internal web browser of Maya has been replaced by a plug-in which allows your own browser to connect with Maya. Please refer help for information on how to setup communication of Maya with external web browser application.

Return value

stringFull path name to the control.

In query mode, return type is based on queried flag.

Flags

annotation, back, backgroundColor, defineTemplate, docTag, dragCallback, dropCallback, enable, exists, find, forward, height, home, isObscured, manage, matchCase, numberOfPopupMenus, openURL, parent, popupMenuArray, preventOverride, reload, searchForward, stop, urlChangedCb, useTemplate, visible, width, wrap
Long name (short name) Argument types Properties
-exists(-ex) create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt) string create
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 create
Force the command to use a command template other than the current one.
-parent(-p) string createquery
The parent layout for this control.
-enable(-en) boolean createqueryedit
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 createqueryedit
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 createqueryedit
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 createqueryedit
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).
-isObscured(-io) query
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 createqueryedit
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.
-numberOfPopupMenus(-npm) query
Return the number of popup menus attached to this control.
-popupMenuArray(-pma) query
Return the names of all the popup menus attached to this control.
-preventOverride(-po) boolean createqueryedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
-annotation(-ann) string createqueryedit
Annotate the control with an extra string value.
-backgroundColor(-bgc) float float float createedit
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. (Windows only flag)
-docTag(-dtg) string createqueryedit
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 createedit
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 createedit
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'")

-openURL(-url) string createqueryedit
URL to open in the web browser. When queried will return the current URL.
-back(-bk) queryedit
Navigate to the previous page in the session history. If queried, will return true if there is a previous page in the session history.
-forward(-fwd) queryedit
Navigate to the next page in the session history. If queried, will return true if there is a next page in the session history.
-home(-hm) edit
Navigate to the home page.
-reload(-rl) edit
Reload last page.
-stop(-st) edit
Stop current page loading process.
-urlChangedCb(-ucc) string createqueryedit
An optional mel callback. If set, it will be called whenever the current URL changes. The mel callback should take one string which will contain the new URL.
-find(-f) string queryedit
If the edit flag is specified then the given string will be searched for within the web page. If queried will return the current word that is being searched for.
-searchForward(-sf) boolean queryedit
Sets the search direction.
-wrap(-wr) boolean queryedit
Sets whether to wrap around the page during text search or stop at the end of the page.
-matchCase(-mc) boolean queryedit
Sets whether or not case matters during text search.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

string $browser;
window;
columnLayout;
    $browser = `webBrowser -width 800 -height 600 -url "www.alias.com"`;
showWindow;