// Name: sizer.h
// Purpose: provide wxSizer class for layout
// Author: Robert Roebling and Robin Dunn
-// Modified by: Ron Lee
+// Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags)
// Created:
// RCS-ID: $Id$
// Copyright: (c) Robin Dunn, Robert Roebling
class WXDLLEXPORT wxSizer;
class WXDLLEXPORT wxBoxSizer;
+
+// ----------------------------------------------------------------------------
+// wxSizerFlags: flags used for an item in the sizer
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxSizerFlags
+{
+public:
+ // construct the flags object initialized with the given proportion (0 by
+ // default)
+ wxSizerFlags(int proportion = 0) : m_proportion(proportion)
+ {
+ m_flags = 0;
+ m_borderInPixels = 0;
+ }
+
+ // setters for all sizer flags, they all return the object itself so that
+ // calls to them can be chained
+
+ wxSizerFlags& Proportion(int proportion)
+ {
+ m_proportion = proportion;
+ return *this;
+ }
+
+ wxSizerFlags& Align(int alignment) // combination of wxAlignment values
+ {
+ m_flags &= wxALL;
+ m_flags |= alignment;
+
+ return *this;
+ }
+
+ // some shortcuts for Align()
+ wxSizerFlags& Expand() { return Align(wxEXPAND); }
+ wxSizerFlags& Centre() { return Align(wxCENTRE); }
+ wxSizerFlags& Center() { return Centre(); }
+
+
+ wxSizerFlags& Border(int direction, int borderInPixels)
+ {
+ m_flags &= ~wxALL;
+ m_flags |= direction;
+
+ m_borderInPixels = borderInPixels;
+
+ return *this;
+ }
+
+ wxSizerFlags& Border(int direction = wxALL)
+ {
+ // FIXME: default border size shouldn't be hardcoded
+ return Border(direction, 5);
+ }
+
+
+ // accessors for wxSizer only
+ int GetProportion() const { return m_proportion; }
+ int GetFlags() const { return m_flags; }
+ int GetBorderInPixels() const { return m_borderInPixels; }
+
+private:
+ int m_proportion;
+ int m_flags;
+ int m_borderInPixels;
+};
+
+
//---------------------------------------------------------------------------
// wxSizerItem
//---------------------------------------------------------------------------
class WXDLLEXPORT wxSizerItem: public wxObject
{
public:
- // spacer
- wxSizerItem( int width,
- int height,
- int proportion,
- int flag,
- int border,
- wxObject* userData);
+ // window with flags
+ wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
+ {
+ Init(flags);
+
+ m_window = window;
+ }
+
+ // sizer with flags
+ wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
+ {
+ Init(flags);
+
+ m_sizer = sizer;
+ }
// window
wxSizerItem( wxWindow *window,
int border,
wxObject* userData );
+ // spacer
+ wxSizerItem( int width,
+ int height,
+ int proportion,
+ int flag,
+ int border,
+ wxObject* userData);
+
wxSizerItem();
virtual ~wxSizerItem();
float GetRatio() const
{ return m_ratio; }
+ virtual wxRect GetRect() { return m_zoneRect; }
+
bool IsWindow() const;
bool IsSizer() const;
bool IsSpacer() const;
{ return m_pos; }
protected:
+ // common part of several ctors
+ void Init();
+
+ // common part of ctors taking wxSizerFlags
+ void Init(const wxSizerFlags& flags);
+
+
wxWindow *m_window;
wxSizer *m_sizer;
wxSize m_size;
int m_proportion;
int m_border;
int m_flag;
+ wxRect m_zoneRect; // Rectangle for window or item (not including borders)
// If true, then this item is considered in the layout
// calculation. Otherwise, it is skipped over.
WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
+
//---------------------------------------------------------------------------
// wxSizer
//---------------------------------------------------------------------------
// methods for adding elements to the sizer: there are Add/Insert/Prepend
// overloads for each of window/sizer/spacer/wxSizerItem
- inline void Add( wxWindow *window,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Add( wxSizer *sizer,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Add( int width,
- int height,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Add( wxSizerItem *item );
-
- inline void AddSpacer(int size);
- inline void AddStretchSpacer(int prop = 1);
-
- inline void Insert( size_t index,
- wxWindow *window,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Insert( size_t index,
- wxSizer *sizer,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Insert( size_t index,
- int width,
- int height,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- virtual void Insert( size_t index, wxSizerItem *item );
-
- inline void InsertSpacer(size_t index, int size);
- inline void InsertStretchSpacer(size_t index, int prop = 1);
-
- inline void Prepend( wxWindow *window,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Prepend( wxSizer *sizer,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Prepend( int width,
- int height,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL );
- inline void Prepend( wxSizerItem *item );
-
- inline void PrependSpacer(int size);
- inline void PrependStretchSpacer(int prop = 1);
+ inline wxSizerItem* Add( wxWindow *window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Add( wxSizer *sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Add( int width,
+ int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags );
+ inline wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags );
+ inline wxSizerItem* Add( wxSizerItem *item );
+
+ inline wxSizerItem* AddSpacer(int size);
+ inline wxSizerItem* AddStretchSpacer(int prop = 1);
+
+ inline wxSizerItem* Insert( size_t index,
+ wxWindow *window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Insert( size_t index,
+ wxSizer *sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Insert( size_t index,
+ int width,
+ int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Insert( size_t index,
+ wxWindow *window,
+ const wxSizerFlags& flags );
+ inline wxSizerItem* Insert( size_t index,
+ wxSizer *sizer,
+ const wxSizerFlags& flags );
+ virtual wxSizerItem* Insert( size_t index, wxSizerItem *item );
+
+ inline wxSizerItem* InsertSpacer(size_t index, int size);
+ inline wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
+
+ inline wxSizerItem* Prepend( wxWindow *window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Prepend( wxSizer *sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Prepend( int width,
+ int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL );
+ inline wxSizerItem* Prepend( wxWindow *window, const wxSizerFlags& flags );
+ inline wxSizerItem* Prepend( wxSizer *sizer, const wxSizerFlags& flags );
+ inline wxSizerItem* Prepend( wxSizerItem *item );
+
+ inline wxSizerItem* PrependSpacer(int size);
+ inline wxSizerItem* PrependStretchSpacer(int prop = 1);
// Deprecated in 2.6 since historically it does not delete the window,
void SetDimension( int x, int y, int width, int height );
+ wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
+ wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
+ wxSizerItem* GetItem( size_t index );
+
// Manage whether individual scene items are considered
// in the layout calculations or not.
bool Show( wxWindow *window, bool show = true, bool recursive = false );
// inline functions implementation
// ----------------------------------------------------------------------------
-inline void
+inline wxSizerItem*
wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
{
- Add( new wxSizerItem( window, proportion, flag, border, userData ) );
+ return Add( new wxSizerItem( window, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
{
- Add( new wxSizerItem( sizer, proportion, flag, border, userData ) );
+ return Add( new wxSizerItem( sizer, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData )
{
- Add( new wxSizerItem( width, height, proportion, flag, border, userData ) );
+ return Add( new wxSizerItem( width, height, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
+wxSizer::Add( wxWindow *window, const wxSizerFlags& flags )
+{
+ return Add( new wxSizerItem(window, flags) );
+}
+
+inline wxSizerItem*
+wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags )
+{
+ return Add( new wxSizerItem(sizer, flags) );
+}
+
+inline wxSizerItem*
wxSizer::Add( wxSizerItem *item )
{
- Insert( m_children.GetCount(), item );
+ return Insert( m_children.GetCount(), item );
}
-inline void
+inline wxSizerItem*
wxSizer::AddSpacer(int size)
{
- Add(size, size);
+ return Add(size, size);
}
-inline void
+inline wxSizerItem*
wxSizer::AddStretchSpacer(int prop)
{
- Add(0, 0, prop);
+ return Add(0, 0, prop);
}
-inline void
+inline wxSizerItem*
wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
{
- Prepend( new wxSizerItem( window, proportion, flag, border, userData ) );
+ return Prepend( new wxSizerItem( window, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
{
- Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) );
+ return Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData )
{
- Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
+ return Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
wxSizer::Prepend( wxSizerItem *item )
{
- Insert( 0, item );
+ return Insert( 0, item );
}
-inline void
+inline wxSizerItem*
wxSizer::PrependSpacer(int size)
{
- Prepend(size, size);
+ return Prepend(size, size);
}
-inline void
+inline wxSizerItem*
wxSizer::PrependStretchSpacer(int prop)
{
- Prepend(0, 0, prop);
+ return Prepend(0, 0, prop);
+}
+
+inline wxSizerItem*
+wxSizer::Prepend( wxWindow *window, const wxSizerFlags& flags )
+{
+ return Prepend( new wxSizerItem(window, flags) );
+}
+
+inline wxSizerItem*
+wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags )
+{
+ return Prepend( new wxSizerItem(sizer, flags) );
}
-inline void
+inline wxSizerItem*
wxSizer::Insert( size_t index,
- wxWindow *window,
- int proportion,
- int flag,
- int border,
- wxObject* userData )
+ wxWindow *window,
+ int proportion,
+ int flag,
+ int border,
+ wxObject* userData )
{
- Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) );
+ return Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
wxSizer::Insert( size_t index,
- wxSizer *sizer,
- int proportion,
- int flag,
- int border,
- wxObject* userData )
+ wxSizer *sizer,
+ int proportion,
+ int flag,
+ int border,
+ wxObject* userData )
{
- Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) );
+ return Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) );
}
-inline void
+inline wxSizerItem*
wxSizer::Insert( size_t index,
- int width,
- int height,
- int proportion,
- int flag,
- int border,
- wxObject* userData )
-{
- Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) );
+ int width,
+ int height,
+ int proportion,
+ int flag,
+ int border,
+ wxObject* userData )
+{
+ return Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) );
+}
+
+inline wxSizerItem*
+wxSizer::Insert( size_t index, wxWindow *window, const wxSizerFlags& flags )
+{
+ return Insert( index, new wxSizerItem(window, flags) );
+}
+
+inline wxSizerItem*
+wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags )
+{
+ return Insert( index, new wxSizerItem(sizer, flags) );
}
-inline void
+inline wxSizerItem*
wxSizer::InsertSpacer(size_t index, int size)
{
- Insert(index, size, size);
+ return Insert(index, size, size);
}
-inline void
+inline wxSizerItem*
wxSizer::InsertStretchSpacer(size_t index, int prop)
{
- Insert(index, 0, 0, prop);
+ return Insert(index, 0, 0, prop);
}
projects / wxWidgets.git / blobdiff