#include <vstgui.h>
class CFrame : public CView;
A frame is an user interface object that is used to draw a frame around other objects. A plug-in create a frame, where the other views (control objects) are attached.
CFrame |
1.0 |
Create a frame with a given rect, the plug-in uses it to construct a frame.
size |
The enclosing rectangle, giving the size of the frame. |
---|---|
systemWindow |
Initialized by the host appliaction. |
editor |
The editor the frame belongs to. |
long MyEditor::open (void *ptr)
{
AEffGUIEditor::open (ptr);
CRect size (
0,
0,
myBackgroundPixmap->getWidth (),
myBackgroundPixmap->getHeight ()
);
frame = new CFrame (size, ptr, this);
...
}
CFrame |
1.0 |
Create a frame with a given rect which is displayed.
size |
The enclosing rectangle of the frame. |
---|---|
title |
- |
editor |
The editor the frame belongs to. |
style |
- |
Use close
and open
to display or undisplay this frame.
~CFrame |
1.0 |
Destroy a frame object.
open |
1.0 |
Open this frame at a given position.
Use only with the 2nd contructor.
close |
1.0 |
Close this frame.
Use only with the 2nd contructor.
isOpen |
1.0 |
Returns true if the frame is open.
draw |
1.0 |
Called when the frame has to be drawn. The background pixmap and the added view are also drawn.
drawRect |
2.2 |
Called when a specific Rect of the frame has to be drawn.
draw |
1.0 |
Draw the specified view attached to the frame. If view is null then all views attached to the frame are drawn.
mouse |
1.0 |
Called when a mouse-click occurs. Dispatch the event to the added view (such as controls).
onDrop |
2.0 |
Something has been dropped here...
onWheel |
2.1 |
onKeyDown |
2.2
|
The user hits a key.
onKeyUp |
2.2 |
The user releases the key.
update |
1.0 |
Called for a update. Only the added view which have a modified value are redrawn.
idle |
1.0 |
Called from VST every Xms for an update. Update the content of the frame.
doIdleStuff |
1.0 |
Call the doIdleStuff of the editor.
getTicks |
2.2 |
Returns system time.
getKnobMode |
2.2 |
Returns the knob mode (can be circular, relativ circular, or linear).
getPosition |
1.0 |
Gets the position of the window including the frame (top-left corner of the Window).
setSize |
1.0 |
Sets a new size to the frame with the given new values.
getSize |
1.0 |
Gets the size of the frame in the screen.
setBackground |
1.0 |
Sets the background pixmap of the frame.
getBackground |
1.0 |
Returns the background pixmap of the frame.
addView |
1.0 |
Add a view (a control object) to the frame.
removeView |
1.0 |
Remove a view of the frame.
removeAll |
2.2 |
Remove all views of the frame..
isChild |
2.0 |
Check whether pView is contained by the frame.
getNbViews |
2.2 |
Returns the number of views inside the frame.
getView |
2.2 |
Returns the view number index from the views contained by the frame.
setModalView |
1.0 |
Sets the given view as a modal view. The other added view are not updated. The value False is returned if the frame is already in modal view.
To unset the modal view, call this function with NULL.
getModalView |
2.1 |
Returns which view in the frame is in modal view.
getSystemWindow |
1.0 |
Each host provides a window (for a plug-in) which is platform-dependant. But
VSTGUI defines another window (directly embedded in the one provided by the
host) which is platform-independent. Calling getSystemWindow
returns
a pointer to the window provided by VSTGUI; getParentSystemWindow (
see
below) returns a pointer to the window provided by the host.
getParentSystemWindow |
2.2 |
setParentSystemWindow |
2.2 |
Sets the ParentSystemWindow to val.
getEditor |
1.0 |
Returns a pointer on the editor of the frame.
getEditor |
2.2 |
Returns a pointer on the editor of the frame.
setEditView |
1.0 |
Sets the current edited view.
getEditView |
1.0 |
Returns the current edited view.
setDropActive |
2.2 |
isDropActive |
2.2 |
Does this frame accept to be used as a drop target?
invalidate |
2.2 |
All views contained by the frame in this rect are set dirty.
setOpenFlag |
2.2 |
Set to true if the frame is open.
getOpenFlag |
2.2 |