/////////////////////////////////////////////////////////////////////////////
// Name: laywin.h
-// Purpose: documentation for wxLayoutAlgorithm class
+// Purpose: interface of wxLayoutAlgorithm
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxadv}
@category{winlayout}
- @seealso
- wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview "Event
- handling overview"
+ @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview
*/
class wxLayoutAlgorithm : public wxObject
{
~wxLayoutAlgorithm();
/**
- Lays out the children of a normal frame. @e mainWindow is set to occupy the
+ Lays out the children of a normal frame. @a mainWindow is set to occupy the
remaining space.
-
This function simply calls LayoutWindow().
*/
- bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = @NULL);
+ bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = NULL) const;
/**
- Lays out the children of an MDI parent frame. If @e rect is non-@NULL, the
+ Lays out the children of an MDI parent frame. If @a rect is non-@NULL, the
given rectangle will be used as a starting point instead of the frame's client
area.
-
The MDI client window is set to occupy the remaining space.
*/
- bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = @NULL);
+ bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = NULL) const;
/**
Lays out the children of a normal frame or other window.
-
- @e mainWindow is set to occupy the remaining space. If this is not specified,
+ @a mainWindow is set to occupy the remaining space. If this is not specified,
then
the last window that responds to a calculate layout event in query mode will
get the remaining space
and the window will be set
to the remaining size).
*/
- bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = @NULL);
+ bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL) const;
};
+
/**
@class wxSashLayoutWindow
@wxheader{laywin.h}
@library{wxadv}
@category{miscwnd}
- @seealso
- wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview "Event
- handling overview"
+ @see wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview
*/
class wxSashLayoutWindow : public wxSashWindow
{
/**
Constructs a sash layout window, which can be a child of a frame, dialog or any
other non-control window.
-
+
@param parent
- Pointer to a parent window.
-
+ Pointer to a parent window.
@param id
- Window identifier. If -1, will automatically create an identifier.
-
+ Window identifier. If -1, will automatically create an identifier.
@param pos
- Window position. wxDefaultPosition is (-1, -1) which indicates that
+ Window position. wxDefaultPosition is (-1, -1) which indicates that
wxSashLayoutWindows
- should generate a default position for the window. If using the
+ should generate a default position for the window. If using the
wxSashLayoutWindow class directly, supply
- an actual position.
-
+ an actual position.
@param size
- Window size. wxDefaultSize is (-1, -1) which indicates that wxSashLayoutWindows
- should generate a default size for the window.
-
+ Window size. wxDefaultSize is (-1, -1) which indicates that
+ wxSashLayoutWindows
+ should generate a default size for the window.
@param style
- Window style. For window styles, please see wxSashLayoutWindow.
-
+ Window style. For window styles, please see wxSashLayoutWindow.
@param name
- Window name.
+ Window name.
*/
wxSashLayoutWindow();
wxSashLayoutWindow(wxSashLayoutWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxCLIP_CHILDREN | wxSW_3D,
+ long style = wxCLIP_CHILDREN | wxSW_3D,
const wxString& name = "layoutWindow");
//@}
/**
Initializes a sash layout window, which can be a child of a frame, dialog or
any other non-control window.
-
+
@param parent
- Pointer to a parent window.
-
+ Pointer to a parent window.
@param id
- Window identifier. If -1, will automatically create an identifier.
-
+ Window identifier. If -1, will automatically create an identifier.
@param pos
- Window position. wxDefaultPosition is (-1, -1) which indicates that
+ Window position. wxDefaultPosition is (-1, -1) which indicates that
wxSashLayoutWindows
- should generate a default position for the window. If using the
+ should generate a default position for the window. If using the
wxSashLayoutWindow class directly, supply
- an actual position.
-
+ an actual position.
@param size
- Window size. wxDefaultSize is (-1, -1) which indicates that wxSashLayoutWindows
- should generate a default size for the window.
-
+ Window size. wxDefaultSize is (-1, -1) which indicates that
+ wxSashLayoutWindows
+ should generate a default size for the window.
@param style
- Window style. For window styles, please see wxSashLayoutWindow.
-
+ Window style. For window styles, please see wxSashLayoutWindow.
@param name
- Window name.
+ Window name.
*/
bool Create(wxSashLayoutWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxCLIP_CHILDREN | wxSW_3D,
+ long style = wxCLIP_CHILDREN | wxSW_3D,
const wxString& name = "layoutWindow");
/**
Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
*/
- wxLayoutAlignment GetAlignment();
+ wxLayoutAlignment GetAlignment() const;
/**
Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL,
wxLAYOUT_VERTICAL.
*/
- wxLayoutOrientation GetOrientation();
+ wxLayoutOrientation GetOrientation() const;
/**
The default handler for the event that is generated by wxLayoutAlgorithm. The
/**
Sets the alignment of the window (which edge of the available parent client
area the window
- is attached to). @e alignment is one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
+ is attached to). @a alignment is one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
*/
void SetAlignment(wxLayoutAlignment alignment);
/**
Sets the orientation of the window (the direction the window will stretch in,
to fill the available
- parent client area). @e orientation is one of wxLAYOUT_HORIZONTAL,
+ parent client area). @a orientation is one of wxLAYOUT_HORIZONTAL,
wxLAYOUT_VERTICAL.
*/
void SetOrientation(wxLayoutOrientation orientation);
};
+
/**
@class wxQueryLayoutInfoEvent
@wxheader{laywin.h}
@library{wxadv}
@category{events}
- @seealso
- wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
+ @see wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
*/
class wxQueryLayoutInfoEvent : public wxEvent
{
the window sticks to). One of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT,
wxLAYOUT_BOTTOM.
*/
- void GetAlignment();
+ void GetAlignment() const;
/**
Returns the flags associated with this event. Not currently used.
*/
- int GetFlags();
+ int GetFlags() const;
/**
Returns the orientation that the event handler specified to the event object.
May be one of wxLAYOUT_HORIZONTAL,
wxLAYOUT_VERTICAL.
*/
- wxLayoutOrientation GetOrientation();
+ wxLayoutOrientation GetOrientation() const;
/**
Returns the requested length of the window in the direction of the window
orientation. This information
is not yet used.
*/
- int GetRequestedLength();
+ int GetRequestedLength() const;
/**
Returns the size that the event handler specified to the event object as being
the requested size of the window.
*/
- wxSize GetSize();
+ wxSize GetSize() const;
/**
Call this to specify the alignment of the window (which side of the remaining
};
+
/**
@class wxCalculateLayoutEvent
@wxheader{laywin.h}
@library{wxadv}
@category{events}
- @seealso
- wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
+ @see wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
*/
class wxCalculateLayoutEvent : public wxEvent
{
/**
Returns the flags associated with this event. Not currently used.
*/
- int GetFlags();
+ int GetFlags() const;
/**
Before the event handler is entered, returns the remaining parent client area
parent client rectangle,
after the event handler has subtracted the area that its window occupies.
*/
- wxRect GetRect();
+ wxRect GetRect() const;
/**
Sets the flags associated with this event. Not currently used.
*/
void SetRect(const wxRect& rect);
};
+
projects / wxWidgets.git / blobdiff