AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
69fc85873d
wxWidgets/interface/wx/aui/framemanager.h

874 lines
27 KiB
Objective-C
Raw Blame History

/////////////////////////////////////////////////////////////////////////////
// Name: aui/aui.h
// Purpose: interface of wxAuiManager
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@todo wxAuiPaneInfo dock direction types used with wxAuiManager.
*/
enum wxAuiManagerDock
{
wxAUI_DOCK_NONE = 0,
wxAUI_DOCK_TOP = 1,
wxAUI_DOCK_RIGHT = 2,
wxAUI_DOCK_BOTTOM = 3,
wxAUI_DOCK_LEFT = 4,
wxAUI_DOCK_CENTER = 5,
wxAUI_DOCK_CENTRE = wxAUI_DOCK_CENTER
};
/**
@todo wxAuiManager behavior style flags.
*/
enum wxAuiManagerOption
{
wxAUI_MGR_ALLOW_FLOATING = 1 << 0,
wxAUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1,
wxAUI_MGR_TRANSPARENT_DRAG = 1 << 2,
wxAUI_MGR_TRANSPARENT_HINT = 1 << 3,
wxAUI_MGR_VENETIAN_BLINDS_HINT = 1 << 4,
wxAUI_MGR_RECTANGLE_HINT = 1 << 5,
wxAUI_MGR_HINT_FADE = 1 << 6,
wxAUI_MGR_NO_VENETIAN_BLINDS_FADE = 1 << 7,
wxAUI_MGR_LIVE_RESIZE = 1 << 8,
wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
wxAUI_MGR_TRANSPARENT_HINT |
wxAUI_MGR_HINT_FADE |
wxAUI_MGR_NO_VENETIAN_BLINDS_FADE
};
/**
@class wxAuiManager
wxAuiManager is the central class of the wxAUI class framework.
wxAuiManager manages the panes associated with it for a particular wxFrame,
using a pane's wxAuiPaneInfo information to determine each pane's docking
and floating behavior.
wxAuiManager uses wxWidgets' sizer mechanism to plan the layout of each
frame. It uses a replaceable dock art class to do all drawing, so all
drawing is localized in one area, and may be customized depending on an
application's specific needs.
wxAuiManager works as follows: the programmer adds panes to the class,
or makes changes to existing pane properties (dock position, floating
state, show state, etc.). To apply these changes, wxAuiManager's
Update() function is called. This batch processing can be used to avoid
flicker, by modifying more than one pane at a time, and then "committing"
all of the changes at once by calling Update().
Panes can be added quite easily:
@code
wxTextCtrl* text1 = new wxTextCtrl(this, -1);
wxTextCtrl* text2 = new wxTextCtrl(this, -1);
m_mgr.AddPane(text1, wxLEFT, "Pane Caption");
m_mgr.AddPane(text2, wxBOTTOM, "Pane Caption");
m_mgr.Update();
@endcode
Later on, the positions can be modified easily. The following will float
an existing pane in a tool window:
@code
m_mgr.GetPane(text1).Float();
@endcode
@section auimanager_layers Layers, Rows and Directions, Positions
Inside wxAUI, the docking layout is figured out by checking several pane
parameters. Four of these are important for determining where a pane will
end up:
@li Direction: Each docked pane has a direction, Top, Bottom, Left, Right,
or Center. This is fairly self-explanatory. The pane will be placed in
the location specified by this variable.
@li Position: More than one pane can be placed inside of a dock. Imagine
two panes being docked on the left side of a window. One pane can be
placed over another. In proportionally managed docks, the pane
position indicates its sequential position, starting with zero. So, in
our scenario with two panes docked on the left side, the top pane in
the dock would have position 0, and the second one would occupy
position 1.
@li Row: A row can allow for two docks to be placed next to each other.
One of the most common places for this to happen is in the toolbar.
Multiple toolbar rows are allowed, the first row being row 0, and the
second row 1. Rows can also be used on vertically docked panes.
@li Layer: A layer is akin to an onion. Layer 0 is the very center of the
managed pane. Thus, if a pane is in layer 0, it will be closest to the
center window (also sometimes known as the "content window").
Increasing layers "swallow up" all layers of a lower value. This can
look very similar to multiple rows, but is different because all panes
in a lower level yield to panes in higher levels. The best way to
understand layers is by running the wxAUI sample.
@beginEventEmissionTable{wxAuiManagerEvent}
@event{EVT_AUI_PANE_BUTTON(func)}
Triggered when any button is pressed for any docked panes.
@event{EVT_AUI_PANE_CLOSE(func)}
Triggered when a docked or floating pane is closed.
@event{EVT_AUI_PANE_MAXIMIZE(func)}
Triggered when a pane is maximized.
@event{EVT_AUI_PANE_RESTORE(func)}
Triggered when a pane is restored.
@event{EVT_AUI_RENDER(func)}
This event can be caught to override the default renderer in order to
custom draw your wxAuiManager window (not recommended).
@endEventTable
@library{wxbase}
@category{aui}
@see @ref overview_aui, wxAuiNotebook, wxAuiDockArt, wxAuiPaneInfo
*/
class wxAuiManager : public wxEvtHandler
{
public:
/**
Constructor. @a managed_wnd specifies the wxFrame which should be managed.
@a flags specifies options which allow the frame management behavior
to be modified.
*/
wxAuiManager(wxWindow* managed_wnd = NULL,
unsigned int flags = wxAUI_MGR_DEFAULT);
/**
Dtor.
*/
virtual ~wxAuiManager();
//@{
/**
AddPane() tells the frame manager to start managing a child window.
There are several versions of this function. The first version allows
the full spectrum of pane parameter possibilities. The second version is
used for simpler user interfaces which do not require as much configuration.
The last version allows a drop position to be specified, which will determine
where the pane will be added.
*/
bool AddPane(wxWindow* window, const wxAuiPaneInfo& pane_info);
bool AddPane(wxWindow* window, int direction = wxLEFT,
const wxString& caption = wxEmptyString);
bool AddPane(wxWindow* window,
const wxAuiPaneInfo& pane_info,
const wxPoint& drop_pos);
//@}
/**
Tells the wxAuiManager to stop managing the pane specified by window.
The window, if in a floated frame, is reparented to the frame managed
by wxAuiManager.
*/
bool DetachPane(wxWindow* window);
/**
Returns an array of all panes managed by the frame manager.
*/
wxAuiPaneInfoArray& GetAllPanes();
/**
Returns the current art provider being used.
@see wxAuiDockArt.
*/
wxAuiDockArt* GetArtProvider() const;
/**
Returns the current dock constraint values.
See SetDockSizeConstraint() for more information.
*/
void GetDockSizeConstraint(double* widthpct, double* heightpct) const;
/**
Returns the current manager's flags.
*/
unsigned int GetFlags() const;
/**
Returns the frame currently being managed by wxAuiManager.
*/
wxWindow* GetManagedWindow() const;
/**
Calling this method will return the wxAuiManager for a given window.
The @a window parameter should specify any child window or sub-child
window of the frame or window managed by wxAuiManager.
The @a window parameter need not be managed by the manager itself, nor does it
even need to be a child or sub-child of a managed window. It must however
be inside the window hierarchy underneath the managed window.
*/
static wxAuiManager* GetManager(wxWindow* window);
//@{
/**
GetPane() is used to lookup a wxAuiPaneInfo object either by window pointer
or by pane name, which acts as a unique id for a window pane.
The returned wxAuiPaneInfo object may then be modified to change a pane's
look, state or position. After one or more modifications to wxAuiPaneInfo,
wxAuiManager::Update() should be called to commit the changes to the user
interface. If the lookup failed (meaning the pane could not be found in the
manager), a call to the returned wxAuiPaneInfo's IsOk() method will return @false.
*/
wxAuiPaneInfo& GetPane(wxWindow* window);
wxAuiPaneInfo& GetPane(const wxString& name);
//@}
/**
HideHint() hides any docking hint that may be visible.
*/
virtual void HideHint();
/**
This method is used to insert either a previously unmanaged pane window
into the frame manager, or to insert a currently managed pane somewhere
else. InsertPane() will push all panes, rows, or docks aside and
insert the window into the position specified by @a insert_location.
Because @a insert_location can specify either a pane, dock row, or dock
layer, the @a insert_level parameter is used to disambiguate this.
The parameter @a insert_level can take a value of wxAUI_INSERT_PANE,
wxAUI_INSERT_ROW or wxAUI_INSERT_DOCK.
*/
bool InsertPane(wxWindow* window,
const wxAuiPaneInfo& insert_location,
int insert_level = wxAUI_INSERT_PANE);
/**
LoadPaneInfo() is similar to to LoadPerspective, with the exception that it
only loads information about a single pane. It is used in combination with
SavePaneInfo().
*/
void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo& pane);
/**
Loads a saved perspective. If update is @true, wxAuiManager::Update()
is automatically invoked, thus realizing the saved perspective on screen.
*/
bool LoadPerspective(const wxString& perspective,
bool update = true);
/**
SavePaneInfo() is similar to SavePerspective, with the exception that it only
saves information about a single pane. It is used in combination with
LoadPaneInfo().
*/
wxString SavePaneInfo(wxAuiPaneInfo& pane);
/**
Saves the entire user interface layout into an encoded wxString, which
can then be stored by the application (probably using wxConfig).
When a perspective is restored using LoadPerspective(), the entire user
interface will return to the state it was when the perspective was saved.
*/
wxString SavePerspective();
/**
Instructs wxAuiManager to use art provider specified by parameter
@a art_provider for all drawing calls.
This allows plugable look-and-feel features. The previous art provider object,
if any, will be deleted by wxAuiManager.
@see wxAuiDockArt.
*/
void SetArtProvider(wxAuiDockArt* art_provider);
/**
When a user creates a new dock by dragging a window into a docked position,
often times the large size of the window will create a dock that is unwieldly
large. wxAuiManager by default limits the size of any new dock to 1/3 of the
window size. For horizontal docks, this would be 1/3 of the window height.
For vertical docks, 1/3 of the width.
Calling this function will adjust this constraint value. The numbers must be
between 0.0 and 1.0. For instance, calling SetDockSizeContraint with
0.5, 0.5 will cause new docks to be limited to half of the size of the
entire managed window.
*/
void SetDockSizeConstraint(double widthpct, double heightpct);
/**
This method is used to specify wxAuiManager's settings flags. @a flags
specifies options which allow the frame management behavior to be modified.
*/
void SetFlags(unsigned int flags);
/**
Called to specify the frame or window which is to be managed by wxAuiManager.
Frame management is not restricted to just frames. Child windows or custom
controls are also allowed.
*/
void SetManagedWindow(wxWindow* managed_wnd);
/**
This function is used by controls to explicitly show a hint window at the
specified rectangle. It is rarely called, and is mostly used by controls
implementing custom pane drag/drop behaviour.
The specified rectangle should be in screen coordinates.
*/
virtual void ShowHint(const wxRect& rect);
/**
Uninitializes the framework and should be called before a managed frame or
window is destroyed. UnInit() is usually called in the managed wxFrame's
destructor. It is necessary to call this function before the managed frame
or window is destroyed, otherwise the manager cannot remove its custom event
handlers from a window.
*/
void UnInit();
/**
This method is called after any number of changes are
made to any of the managed panes. Update() must be invoked after
AddPane() or InsertPane() are called in order to "realize" or "commit"
the changes. In addition, any number of changes may be made to
wxAuiPaneInfo structures (retrieved with wxAuiManager::GetPane), but to
realize the changes, Update() must be called. This construction allows
pane flicker to be avoided by updating the whole layout at one time.
*/
void Update();
protected:
/**
ProcessDockResult() is a protected member of the wxAUI layout manager.
It can be overridden by derived classes to provide custom docking calculations.
*/
virtual bool ProcessDockResult(wxAuiPaneInfo& target,
const wxAuiPaneInfo& new_pos);
};
/**
@class wxAuiPaneInfo
wxAuiPaneInfo is part of the wxAUI class framework.
See also @ref overview_aui.
wxAuiPaneInfo specifies all the parameters for a pane.
These parameters specify where the pane is on the screen, whether it is docked
or floating, or hidden.
In addition, these parameters specify the pane's docked position, floating
position, preferred size, minimum size, caption text among many other parameters.
@library{wxbase}
@category{aui}
@see wxAuiManager, wxAuiDockArt
*/
class wxAuiPaneInfo
{
public:
wxAuiPaneInfo();
/**
Copy constructor.
*/
wxAuiPaneInfo(const wxAuiPaneInfo& c);
//@{
/**
BestSize() sets the ideal size for the pane. The docking manager will attempt
to use this size as much as possible when docking or floating the pane.
*/
wxAuiPaneInfo& BestSize(const wxSize& size);
wxAuiPaneInfo& BestSize(int x, int y);
//@}
/**
Bottom() sets the pane dock position to the bottom side of the frame. This is
the same thing as calling Direction(wxAUI_DOCK_BOTTOM).
*/
wxAuiPaneInfo& Bottom();
/**
BottomDockable() indicates whether a pane can be docked at the bottom of the
frame.
*/
wxAuiPaneInfo& BottomDockable(bool b = true);
/**
Caption() sets the caption of the pane.
*/
wxAuiPaneInfo& Caption(const wxString& c);
/**
CaptionVisible indicates that a pane caption should be visible. If @false, no
pane caption is drawn.
*/
wxAuiPaneInfo& CaptionVisible(bool visible = true);
//@{
/**
Center() sets the pane dock position to the left side of the frame.
The centre pane is the space in the middle after all border panes (left, top,
right, bottom) are subtracted from the layout.
This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
*/
wxAuiPaneInfo& Centre();
wxAuiPaneInfo& Center();
//@}
//@{
/**
CentrePane() specifies that the pane should adopt the default center pane
settings. Centre panes usually do not have caption bars.
This function provides an easy way of preparing a pane to be displayed in
the center dock position.
*/
wxAuiPaneInfo& CentrePane();
wxAuiPaneInfo& CenterPane();
//@}
/**
CloseButton() indicates that a close button should be drawn for the pane.
*/
wxAuiPaneInfo& CloseButton(bool visible = true);
/**
DefaultPane() specifies that the pane should adopt the default pane settings.
*/
wxAuiPaneInfo& DefaultPane();
/**
DestroyOnClose() indicates whether a pane should be detroyed when it is closed.
Normally a pane is simply hidden when the close button is clicked.
Setting DestroyOnClose to @true will cause the window to be destroyed when
the user clicks the pane's close button.
*/
wxAuiPaneInfo& DestroyOnClose(bool b = true);
/**
Direction() determines the direction of the docked pane. It is functionally the
same as calling Left(), Right(), Top() or Bottom(), except that docking direction
may be specified programmatically via the parameter.
*/
wxAuiPaneInfo& Direction(int direction);
/**
Dock() indicates that a pane should be docked. It is the opposite of Float().
*/
wxAuiPaneInfo& Dock();
/**
DockFixed() causes the containing dock to have no resize sash. This is useful
for creating panes that span the entire width or height of a dock, but should
not be resizable in the other direction.
*/
wxAuiPaneInfo& DockFixed(bool b = true);
/**
Dockable() specifies whether a frame can be docked or not. It is the same as
specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
*/
wxAuiPaneInfo& Dockable(bool b = true);
/**
Fixed() forces a pane to be fixed size so that it cannot be resized. After
calling Fixed(), IsFixed() will return @true.
*/
wxAuiPaneInfo& Fixed();
/**
Float() indicates that a pane should be floated. It is the opposite of Dock().
*/
wxAuiPaneInfo& Float();
/**
Floatable() sets whether the user will be able to undock a pane and turn it
into a floating window.
*/
wxAuiPaneInfo& Floatable(bool b = true);
//@{
/**
FloatingPosition() sets the position of the floating pane.
*/
wxAuiPaneInfo& FloatingPosition(const wxPoint& pos);
wxAuiPaneInfo& FloatingPosition(int x, int y);
//@}
//@{
/**
FloatingSize() sets the size of the floating pane.
*/
wxAuiPaneInfo& FloatingSize(const wxSize& size);
wxAuiPaneInfo& FloatingSize(int x, int y);
//@}
/**
Gripper() indicates that a gripper should be drawn for the pane.
*/
wxAuiPaneInfo& Gripper(bool visible = true);
/**
GripperTop() indicates that a gripper should be drawn at the top of the pane.
*/
wxAuiPaneInfo& GripperTop(bool attop = true);
/**
HasBorder() returns @true if the pane displays a border.
*/
bool HasBorder() const;
/**
HasCaption() returns @true if the pane displays a caption.
*/
bool HasCaption() const;
/**
HasCloseButton() returns @true if the pane displays a button to close the pane.
*/
bool HasCloseButton() const;
/**
HasFlag() returns @true if the property specified by flag is active for
the pane.
*/
bool HasFlag(int flag) const;
/**
HasGripper() returns @true if the pane displays a gripper.
*/
bool HasGripper() const;
/**
HasGripper() returns @true if the pane displays a gripper at the top.
*/
bool HasGripperTop() const;
/**
HasMaximizeButton() returns @true if the pane displays a button to maximize the
pane.
*/
bool HasMaximizeButton() const;
/**
HasMinimizeButton() returns @true if the pane displays a button to minimize the
pane.
*/
bool HasMinimizeButton() const;
/**
HasPinButton() returns @true if the pane displays a button to float the pane.
*/
bool HasPinButton() const;
/**
Hide() indicates that a pane should be hidden.
*/
wxAuiPaneInfo& Hide();
/**
IsBottomDockable() returns @true if the pane can be docked at the bottom of the
managed frame.
*/
bool IsBottomDockable() const;
/**
IsDocked() returns @true if the pane is docked.
*/
bool IsDocked() const;
/**
IsFixed() returns @true if the pane cannot be resized.
*/
bool IsFixed() const;
/**
IsFloatable() returns @true if the pane can be undocked and displayed as a
floating window.
*/
bool IsFloatable() const;
/**
IsFloating() returns @true if the pane is floating.
*/
bool IsFloating() const;
/**
IsLeftDockable() returns @true if the pane can be docked on the left of the
managed frame.
*/
bool IsLeftDockable() const;
/**
IsMoveable() returns @true if the docked frame can be undocked or moved to
another dock position.
*/
bool IsMovable() const;
/**
IsOk() returns @true if the wxAuiPaneInfo structure is valid. A pane structure
is valid if it has an associated window.
*/
bool IsOk() const;
/**
IsResizable() returns @true if the pane can be resized.
*/
bool IsResizable() const;
/**
IsRightDockable() returns @true if the pane can be docked on the right of the
managed frame.
*/
bool IsRightDockable() const;
/**
IsShown() returns @true if the pane is currently shown.
*/
bool IsShown() const;
/**
IsToolbar() returns @true if the pane contains a toolbar.
*/
bool IsToolbar() const;
/**
IsTopDockable() returns @true if the pane can be docked at the top of the
managed frame.
*/
bool IsTopDockable() const;
/**
Layer() determines the layer of the docked pane. The dock layer is similar to
an onion, the inner-most layer being layer 0. Each shell moving in the outward
direction has a higher layer number. This allows for more complex docking layout
formation.
*/
wxAuiPaneInfo& Layer(int layer);
/**
Left() sets the pane dock position to the left side of the frame. This is the
same thing as calling Direction(wxAUI_DOCK_LEFT).
*/
wxAuiPaneInfo& Left();
/**
LeftDockable() indicates whether a pane can be docked on the left of the frame.
*/
wxAuiPaneInfo& LeftDockable(bool b = true);
//@{
/**
MaxSize() sets the maximum size of the pane.
*/
wxAuiPaneInfo& MaxSize(const wxSize& size);
wxAuiPaneInfo& MaxSize(int x, int y);
//@}
/**
MaximizeButton() indicates that a maximize button should be drawn for the pane.
*/
wxAuiPaneInfo& MaximizeButton(bool visible = true);
//@{
/**
MinSize() sets the minimum size of the pane. Please note that this is only
partially supported as of this writing.
*/
wxAuiPaneInfo& MinSize(const wxSize& size);
wxAuiPaneInfo& MinSize(int x, int y);
//@}
/**
MinimizeButton() indicates that a minimize button should be drawn for the pane.
*/
wxAuiPaneInfo& MinimizeButton(bool visible = true);
/**
Movable indicates whether a frame can be moved.
*/
wxAuiPaneInfo& Movable(bool b = true);
/**
Name() sets the name of the pane so it can be referenced in lookup functions.
If a name is not specified by the user, a random name is assigned to the pane
when it is added to the manager.
*/
wxAuiPaneInfo& Name(const wxString& n);
/**
PaneBorder indicates that a border should be drawn for the pane.
*/
wxAuiPaneInfo& PaneBorder(bool visible = true);
/**
PinButton() indicates that a pin button should be drawn for the pane.
*/
wxAuiPaneInfo& PinButton(bool visible = true);
/**
Position() determines the position of the docked pane.
*/
wxAuiPaneInfo& Position(int pos);
/**
Resizable() allows a pane to be resized if the parameter is @true, and forces it
to be a fixed size if the parameter is @false. This is simply an antonym for Fixed().
*/
wxAuiPaneInfo& Resizable(bool resizable = true);
/**
Right() sets the pane dock position to the right side of the frame.
*/
wxAuiPaneInfo& Right();
/**
RightDockable() indicates whether a pane can be docked on the right of the
frame.
*/
wxAuiPaneInfo& RightDockable(bool b = true);
/**
Row() determines the row of the docked pane.
*/
wxAuiPaneInfo& Row(int row);
/**
Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
used on loading perspectives etc.
*/
void SafeSet(wxAuiPaneInfo source);
/**
SetFlag() turns the property given by flag on or off with the option_state
parameter.
*/
wxAuiPaneInfo& SetFlag(int flag, bool option_state);
/**
Show() indicates that a pane should be shown.
*/
wxAuiPaneInfo& Show(bool show = true);
/**
ToolbarPane() specifies that the pane should adopt the default toolbar pane
settings.
*/
wxAuiPaneInfo& ToolbarPane();
/**
Top() sets the pane dock position to the top of the frame.
*/
wxAuiPaneInfo& Top();
/**
TopDockable() indicates whether a pane can be docked at the top of the frame.
*/
wxAuiPaneInfo& TopDockable(bool b = true);
/**
Window() assigns the window pointer that the wxAuiPaneInfo should use.
This normally does not need to be specified, as the window pointer is
automatically assigned to the wxAuiPaneInfo structure as soon as it is added
to the manager.
*/
wxAuiPaneInfo& Window(wxWindow* w);
/**
Makes a copy of the wxAuiPaneInfo object.
*/
wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c);
};
/**
@class wxAuiManagerEvent
Event used to indicate various actions taken with wxAuiManager.
See wxAuiManager for available event types.
@library{wxaui}
@category{events,aui}
@see wxAuiManager, wxAuiPaneInfo
*/
class wxAuiManagerEvent : public wxEvent
{
public:
/**
Constructor.
*/
wxAuiManagerEvent(wxEventType type = wxEVT_NULL);
/**
@return @true if this event can be vetoed.
@see Veto()
*/
bool CanVeto();
/**
@return The ID of the button that was clicked.
*/
int GetButton();
/**
@todo What is this?
*/
wxDC* GetDC();
/**
@return @true if this event was vetoed.
@see Veto()
*/
bool GetVeto();
/**
@return The wxAuiManager this event is associated with.
*/
wxAuiManager* GetManager();
/**
@return The pane this event is associated with.
*/
wxAuiPaneInfo* GetPane();
/**
Sets the ID of the button clicked that triggered this event.
*/
void SetButton(int button);
/**
Sets whether or not this event can be vetoed.
*/
void SetCanVeto(bool can_veto);
/**
@todo What is this?
*/
void SetDC(wxDC* pdc);
/**
Sets the wxAuiManager this event is associated with.
*/
void SetManager(wxAuiManager* manager);
/**
Sets the pane this event is associated with.
*/
void SetPane(wxAuiPaneInfo* pane);
/**
Cancels the action indicated by this event if CanVeto() is @true.
*/
void Veto(bool veto = true);
};
Reference in New Issue View Git Blame Copy Permalink