#include <berryIStackPresentationSite.h>
Represents the main interface between a StackPresentation and the workbench.
Not intended to be implemented by clients.
- Since
- 3.0 This interface is not intended to be implemented by clients.
Definition at line 39 of file berryIStackPresentationSite.h.
berry::IStackPresentationSite::~IStackPresentationSite |
( |
| ) |
|
Closes the given set of parts.
- Parameters
-
toClose | the set of parts to close (Not null. All of the entries must be non-null) |
virtual void berry::IStackPresentationSite::DragStart |
( |
IPresentablePart::Pointer |
beingDragged, |
|
|
QPoint & |
initialPosition, |
|
|
bool |
keyboard |
|
) |
| |
|
pure virtual |
Begins dragging the given part
- Parameters
-
beingDragged | the part to drag (not null) |
initialPosition | the mouse position at the time of the initial mousedown (display coordinates, not null) |
keyboard | true iff the drag was initiated via mouse dragging, and false if the drag may be using the keyboard |
virtual void berry::IStackPresentationSite::DragStart |
( |
QPoint & |
initialPosition, |
|
|
bool |
keyboard |
|
) |
| |
|
pure virtual |
Begins dragging the entire stack of parts
- Parameters
-
initialPosition | the mouse position at the time of the initial mousedown (display coordinates, not null) |
keyboard | true iff the drag was initiated via mouse dragging, and false if the drag may be using the keyboard |
virtual void berry::IStackPresentationSite::FlushLayout |
( |
| ) |
|
|
pure virtual |
Adds system actions to the given menu manager. The site may make use of the following group ids:
-
close
, for close actions
-
size
, for resize actions
-
misc
, for miscellaneous actions
The presentation can control the insertion position by creating these group IDs where appropriate.
- Parameters
-
menuManager | the menu manager to populate Notifies the workbench that the preferred size of the presentation has changed. Hints to the workbench that it should trigger a layout at the next opportunity. |
- Since
- 3.1
Returns the list of presentable parts currently in this site
- Returns
- the list of presentable parts currently in this site
- Since
- 3.1
virtual QString berry::IStackPresentationSite::GetProperty |
( |
const QString & |
id | ) |
|
|
pure virtual |
Returns the property with the given id or null
. Folder properties are an extensible mechanism for perspective authors to customize the appearance of view stacks. The list of customizable properties is determined by the presentation factory, and set in the perspective factory.
- Parameters
-
- Returns
- property value, or
null
if the property is not set.
- Since
- 3.3
Returns the currently selected part or null if the stack is empty
- Returns
- the currently selected part or null if the stack is empty
virtual int berry::IStackPresentationSite::GetState |
( |
| ) |
|
|
pure virtual |
Returns the current state of the site (one of the STATE_* constants)
- Returns
- the current state of the site (one of the STATE_* constants)
Returns true iff this site will allow the given part to be closed
- Parameters
-
toClose | part to test (not null) |
- Returns
- true iff the part may be closed
Returns true iff the given part can be dragged. If this returns false, the given part should not trigger a drag.
- Parameters
-
toMove | part to test (not null) |
- Returns
- true iff this part is a valid drag source
virtual bool berry::IStackPresentationSite::IsStackMoveable |
( |
| ) |
|
|
pure virtual |
Returns true iff this entire stack can be dragged
- Returns
- true iff the stack can be dragged
Makes the given part active
- Parameters
-
virtual void berry::IStackPresentationSite::SetState |
( |
int |
newState | ) |
|
|
pure virtual |
Sets the state of the container. Called by the presentation when the user causes the the container to be minimized, maximized, etc.
- Parameters
-
newState | one of the STATE_* constants |
virtual bool berry::IStackPresentationSite::SupportsState |
( |
int |
state | ) |
|
|
pure virtual |
Returns true iff the site supports the given state
- Parameters
-
state | one of the STATE_* constants, above |
- Returns
- true iff the site supports the given state
int berry::IStackPresentationSite::STATE_MAXIMIZED |
|
static |
int berry::IStackPresentationSite::STATE_RESTORED |
|
static |
The documentation for this struct was generated from the following files: