A newer version of Max is available. Click here to access the latest version of the Max documentation

pcontrol

Open and close subwindows

Description

Serves as a remote control for patcher/subpatcher windows and functions.

Examples

Show/hide a subpatch window, or enable/disable its MIDI objects

Arguments

None.

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

close

Arguments

patcher [list]
Closes the patcher window of any subpatches or patcher objects connected to the pcontrol object's outlet.

help

Arguments

filename [symbol]
The word help, followed by a symbol, opens a help file in Max's max-help folder with the name of the symbol followed by .help.

load

Arguments

filename [list]
The word load, followed by the name of a patcher file, opens that file if it can be found in Max's search path. The file name may optionally be followed by up to nine numbers and/or symbols, which will be substituted for the appropriate changeable # arguments (#1 to #9) in the patch being opened.

loadunique

Arguments

patcher [list]
The word loadunique, followed by the name of a patcher file, opens a single instance that file if it can be found in Max's search path. If the file has already been loaded, the previously loaded copy will be activated (i.e. only a single copy of the file may be opened). As with the load message, the file name may optionally be followed by up to nine numbers and/or symbols, which will be substituted for the appropriate changeable # arguments (#1 to #9) in the patch being opened.

open

Arguments

patcher [list]
Opens the patcher window of any subpatches or patcher objects connected to the pcontrol object's outlet.

shroud

Arguments

filename [list]
The word shroud, followed by the name of a patcher file, opens that file but does not show its window. (Use this message with care, since having patchers open but invisible can potentially lead to some disconcerting results.)

Output

Patcher-Control

Any subpatches or patcher objects connected to the pcontrol object's outlet can have their patcher window opened or closed, or MIDI enabled/disabled, when the appropriate message is received in the inlet of pcontrol.

See Also

Name Description
Sharing Max Patchers Sharing Max Patchers
Configuring Objects In A Patcher Configuring Objects In A Patcher
bpatcher Embed a subpatch with a visible UI
inlet Receive messages from outside a patcher
patcher Create a subpatch within a patch
thispatcher Send messages to a patcher