/////////////////////////////////////////////////////////////////////////////
-// Name: sizer.h
+// Name: wx/sizer.h
// Purpose: provide wxSizer class for layout
// Author: Robert Roebling and Robin Dunn
// Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags)
#ifndef __WXSIZER_H__
#define __WXSIZER_H__
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "sizer.h"
-#endif
-
#include "wx/defs.h"
-#include "wx/button.h"
#include "wx/window.h"
-#include "wx/frame.h"
-#include "wx/dialog.h"
-#include "wx/bookctrl.h"
//---------------------------------------------------------------------------
// classes
//---------------------------------------------------------------------------
+class WXDLLEXPORT wxButton;
+class WXDLLEXPORT wxBoxSizer;
class WXDLLEXPORT wxSizerItem;
class WXDLLEXPORT wxSizer;
-class WXDLLEXPORT wxBoxSizer;
+#ifndef wxUSE_BORDER_BY_DEFAULT
+ #ifdef __SMARTPHONE__
+ // no borders by default on limited size screen
+ #define wxUSE_BORDER_BY_DEFAULT 0
+ #else
+ #define wxUSE_BORDER_BY_DEFAULT 1
+ #endif
+#endif
// ----------------------------------------------------------------------------
// wxSizerFlags: flags used for an item in the sizer
wxSizerFlags& Align(int alignment) // combination of wxAlignment values
{
- m_flags &= wxALL;
+ m_flags &= ~wxALIGN_MASK;
m_flags |= alignment;
return *this;
}
+ wxSizerFlags& Expand()
+ {
+ m_flags |= wxEXPAND;
+ return *this;
+ }
+
// some shortcuts for Align()
- wxSizerFlags& Expand() { return Align(wxEXPAND); }
wxSizerFlags& Centre() { return Align(wxCENTRE); }
wxSizerFlags& Center() { return Centre(); }
+ wxSizerFlags& Left() { return Align(wxALIGN_LEFT); }
+ wxSizerFlags& Right() { return Align(wxALIGN_RIGHT); }
+
+ // default border size used by Border() below
+ static int GetDefaultBorder()
+ {
+#if wxUSE_BORDER_BY_DEFAULT
+ // FIXME: default border size shouldn't be hardcoded and at the very
+ // least they should depend on the current font size
+ return 5;
+#else
+ return 0;
+#endif
+ }
wxSizerFlags& Border(int direction, int borderInPixels)
wxSizerFlags& Border(int direction = wxALL)
{
- // FIXME: default border size shouldn't be hardcoded
- return Border(direction, 5);
+#if wxUSE_BORDER_BY_DEFAULT
+ return Border(direction, GetDefaultBorder());
+#else
+ // no borders by default on limited size screen
+ wxUnusedVar(direction);
+
+ return *this;
+#endif
}
+ wxSizerFlags& DoubleBorder(int direction = wxALL)
+ {
+#if wxUSE_BORDER_BY_DEFAULT
+ return Border(direction, 2*GetDefaultBorder());
+#else
+ wxUnusedVar(direction);
+
+ return *this;
+#endif
+ }
+
+ wxSizerFlags& TripleBorder(int direction = wxALL)
+ {
+#if wxUSE_BORDER_BY_DEFAULT
+ return Border(direction, 3*GetDefaultBorder());
+#else
+ wxUnusedVar(direction);
+
+ return *this;
+#endif
+ }
+
+ wxSizerFlags& HorzBorder()
+ {
+#if wxUSE_BORDER_BY_DEFAULT
+ return Border(wxLEFT | wxRIGHT, GetDefaultBorder());
+#else
+ return *this;
+#endif
+ }
+
+ wxSizerFlags& DoubleHorzBorder()
+ {
+#if wxUSE_BORDER_BY_DEFAULT
+ return Border(wxLEFT | wxRIGHT, 2*GetDefaultBorder());
+#else
+ return *this;
+#endif
+ }
// accessors for wxSizer only
int GetProportion() const { return m_proportion; }
};
-//---------------------------------------------------------------------------
-// wxSizerItem
-//---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// wxSizerSpacer: used by wxSizerItem to represent a spacer
+// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxSizerItem: public wxObject
+class WXDLLEXPORT wxSizerSpacer
{
public:
- // window with flags
- wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
- {
- Init(flags);
+ wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { }
- m_window = window;
- }
+ void SetSize(const wxSize& size) { m_size = size; }
+ const wxSize& GetSize() const { return m_size; }
- // sizer with flags
- wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
- {
- Init(flags);
+ void Show(bool show) { m_isShown = show; }
+ bool IsShown() const { return m_isShown; }
- m_sizer = sizer;
- }
+private:
+ // the size, in pixel
+ wxSize m_size;
+ // is the spacer currently shown?
+ bool m_isShown;
+};
+
+// ----------------------------------------------------------------------------
+// wxSizerItem
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxSizerItem : public wxObject
+{
+public:
// window
wxSizerItem( wxWindow *window,
int proportion,
int border,
wxObject* userData );
+ // window with flags
+ wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
+ {
+ Init(flags);
+
+ SetWindow(window);
+ }
+
// subsizer
wxSizerItem( wxSizer *sizer,
int proportion,
int border,
wxObject* userData );
+ // sizer with flags
+ wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
+ {
+ Init(flags);
+
+ SetSizer(sizer);
+ }
+
// spacer
wxSizerItem( int width,
int height,
int border,
wxObject* userData);
+ // spacer with flags
+ wxSizerItem(int width, int height, const wxSizerFlags& flags)
+ {
+ Init(flags);
+
+ SetSpacer(width, height);
+ }
+
wxSizerItem();
virtual ~wxSizerItem();
virtual void DeleteWindows();
// Enable deleting the SizerItem without destroying the contained sizer.
- void DetachSizer()
- { m_sizer = 0; }
+ void DetachSizer() { m_sizer = NULL; }
virtual wxSize GetSize() const;
virtual wxSize CalcMin();
- virtual void SetDimension( wxPoint pos, wxSize size );
+ virtual void SetDimension( const wxPoint& pos, const wxSize& size );
wxSize GetMinSize() const
{ return m_minSize; }
wxSize GetMinSizeWithBorder() const;
void SetMinSize(const wxSize& size)
- {
- if (IsWindow()) m_window->SetMinSize(size);
- m_minSize = size;
- }
+ {
+ if ( IsWindow() )
+ m_window->SetMinSize(size);
+ m_minSize = size;
+ }
void SetMinSize( int x, int y )
{ SetMinSize(wxSize(x, y)); }
void SetInitSize( int x, int y )
{ SetMinSize(wxSize(x, y)); }
- void SetRatio( int width, int height )
- // if either of dimensions is zero, ratio is assumed to be 1
- // to avoid "divide by zero" errors
+ // if either of dimensions is zero, ratio is assumed to be 1
+ // to avoid "divide by zero" errors
+ void SetRatio(int width, int height)
{ m_ratio = (width && height) ? ((float) width / (float) height) : 1; }
- void SetRatio( wxSize size )
- { m_ratio = (size.x && size.y) ? ((float) size.x / (float) size.y) : 1; }
- void SetRatio( float ratio )
+ void SetRatio(const wxSize& size)
+ { SetRatio(size.x, size.y); }
+ void SetRatio(float ratio)
{ m_ratio = ratio; }
float GetRatio() const
{ return m_ratio; }
- virtual wxRect GetRect() { return m_zoneRect; }
+ virtual wxRect GetRect() { return m_rect; }
- bool IsWindow() const;
- bool IsSizer() const;
- bool IsSpacer() const;
+ bool IsWindow() const { return m_kind == Item_Window; }
+ bool IsSizer() const { return m_kind == Item_Sizer; }
+ bool IsSpacer() const { return m_kind == Item_Spacer; }
+#if WXWIN_COMPATIBILITY_2_6
// Deprecated in 2.6, use {G,S}etProportion instead.
wxDEPRECATED( void SetOption( int option ) );
wxDEPRECATED( int GetOption() const );
+#endif // WXWIN_COMPATIBILITY_2_6
void SetProportion( int proportion )
{ m_proportion = proportion; }
{ return m_border; }
wxWindow *GetWindow() const
- { return m_window; }
- void SetWindow( wxWindow *window )
- { m_window = window; m_minSize = window->GetSize(); }
+ { return m_kind == Item_Window ? m_window : NULL; }
wxSizer *GetSizer() const
- { return m_sizer; }
- void SetSizer( wxSizer *sizer )
- { m_sizer = sizer; }
- const wxSize &GetSpacer() const
- { return m_size; }
- void SetSpacer( const wxSize &size )
- { m_size = size; m_minSize = size; }
+ { return m_kind == Item_Sizer ? m_sizer : NULL; }
+ wxSize GetSpacer() const;
- void Show ( bool show );
- bool IsShown() const
- { return m_show; }
+ // this function behaves obviously for the windows and spacers but for the
+ // sizers it returns true if any sizer element is shown and only returns
+ // false if all of them are hidden
+ bool IsShown() const;
+ void Show(bool show);
+ void SetUserData(wxObject* userData)
+ { delete m_userData; m_userData = userData; }
wxObject* GetUserData() const
{ return m_userData; }
wxPoint GetPosition() const
{ return m_pos; }
+
+ // these functions do not free old sizer/spacer
+ void SetWindow(wxWindow *window);
+ void SetSizer(wxSizer *sizer);
+ void SetSpacer(const wxSize& size);
+ void SetSpacer(int width, int height) { SetSpacer(wxSize(width, height)); }
+
protected:
// common part of several ctors
- void Init();
+ void Init() { m_userData = NULL; }
// common part of ctors taking wxSizerFlags
void Init(const wxSizerFlags& flags);
- wxWindow *m_window;
- wxSizer *m_sizer;
- wxSize m_size;
+ // discriminated union: depending on m_kind one of the fields is valid
+ enum
+ {
+ Item_None,
+ Item_Window,
+ Item_Sizer,
+ Item_Spacer,
+ Item_Max
+ } m_kind;
+ union
+ {
+ wxWindow *m_window;
+ wxSizer *m_sizer;
+ wxSizerSpacer *m_spacer;
+ };
+
wxPoint m_pos;
wxSize m_minSize;
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.
- bool m_show;
+ // on screen rectangle of this item (not including borders)
+ wxRect m_rect;
// Aspect ratio can always be calculated from m_size,
// but this would cause precision loss when the window
class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
{
public:
- wxSizer();
- ~wxSizer();
+ wxSizer() { m_containingWindow = NULL; }
+ virtual ~wxSizer();
// methods for adding elements to the sizer: there are Add/Insert/Prepend
// overloads for each of window/sizer/spacer/wxSizerItem
- 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);
-
-
+ wxSizerItem* Add(wxWindow *window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Add(wxSizer *sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Add(int width,
+ int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags);
+ wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags);
+ wxSizerItem* Add( wxSizerItem *item);
+
+ wxSizerItem* AddSpacer(int size);
+ wxSizerItem* AddStretchSpacer(int prop = 1);
+
+ wxSizerItem* Insert(size_t index,
+ wxWindow *window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Insert(size_t index,
+ wxSizer *sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Insert(size_t index,
+ int width,
+ int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Insert(size_t index,
+ wxWindow *window,
+ const wxSizerFlags& flags);
+ wxSizerItem* Insert(size_t index,
+ wxSizer *sizer,
+ const wxSizerFlags& flags);
+ virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
+
+ wxSizerItem* InsertSpacer(size_t index, int size);
+ wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
+
+ wxSizerItem* Prepend(wxWindow *window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Prepend(wxSizer *sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Prepend(int width,
+ int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Prepend(wxWindow *window, const wxSizerFlags& flags);
+ wxSizerItem* Prepend(wxSizer *sizer, const wxSizerFlags& flags);
+ wxSizerItem* Prepend(wxSizerItem *item);
+
+ wxSizerItem* PrependSpacer(int size);
+ wxSizerItem* PrependStretchSpacer(int prop = 1);
+
+ // set (or possibly unset if window is NULL) or get the window this sizer
+ // is used in
+ void SetContainingWindow(wxWindow *window);
+ wxWindow *GetContainingWindow() const { return m_containingWindow; }
+
+#if WXWIN_COMPATIBILITY_2_6
// Deprecated in 2.6 since historically it does not delete the window,
// use Detach instead.
wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
+#endif // WXWIN_COMPATIBILITY_2_6
+
virtual bool Remove( wxSizer *sizer );
virtual bool Remove( int index );
virtual bool Detach( wxSizer *sizer );
virtual bool Detach( int index );
+ virtual bool Replace( wxWindow *oldwin, wxWindow *newwin, bool recursive = false );
+ virtual bool Replace( wxSizer *oldsz, wxSizer *newsz, bool recursive = false );
+ virtual bool Replace( size_t index, wxSizerItem *newitem );
+
virtual void Clear( bool delete_windows = false );
virtual void DeleteWindows();
void SetMinSize( int width, int height )
{ DoSetMinSize( width, height ); }
- void SetMinSize( wxSize size )
+ void SetMinSize( const wxSize& size )
{ DoSetMinSize( size.x, size.y ); }
- /* Searches recursively */
+ // Searches recursively
bool SetItemMinSize( wxWindow *window, int width, int height )
{ return DoSetItemMinSize( window, width, height ); }
- bool SetItemMinSize( wxWindow *window, wxSize size )
+ bool SetItemMinSize( wxWindow *window, const wxSize& size )
{ return DoSetItemMinSize( window, size.x, size.y ); }
- /* Searches recursively */
+ // Searches recursively
bool SetItemMinSize( wxSizer *sizer, int width, int height )
{ return DoSetItemMinSize( sizer, width, height ); }
- bool SetItemMinSize( wxSizer *sizer, wxSize size )
+ bool SetItemMinSize( wxSizer *sizer, const wxSize& size )
{ return DoSetItemMinSize( sizer, size.x, size.y ); }
bool SetItemMinSize( size_t index, int width, int height )
{ return DoSetItemMinSize( index, width, height ); }
- bool SetItemMinSize( size_t index, wxSize size )
+ bool SetItemMinSize( size_t index, const wxSize& size )
{ return DoSetItemMinSize( index, size.x, size.y ); }
wxSize GetSize() const
wxPoint GetPosition() const
{ return m_position; }
- /* Calculate the minimal size or return m_minSize if bigger. */
+ // Calculate the minimal size or return m_minSize if bigger.
wxSize GetMinSize();
virtual void RecalcSizes() = 0;
// Recursively call wxWindow::Show () on all sizer items.
virtual void ShowItems (bool show);
+ void Show(bool show) { ShowItems(show); }
+
protected:
wxSize m_size;
wxSize m_minSize;
wxPoint m_position;
wxSizerItemList m_children;
+ // the window this sizer is used in, can be NULL
+ wxWindow *m_containingWindow;
+
wxSize GetMaxWindowSize( wxWindow *window ) const;
wxSize GetMinWindowSize( wxWindow *window );
wxSize GetMaxClientSize( wxWindow *window ) const;
class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
{
public:
- wxStaticBoxSizer( wxStaticBox *box, int orient );
+ wxStaticBoxSizer(wxStaticBox *box, int orient);
+ wxStaticBoxSizer(int orient, wxWindow *win, const wxString& label = wxEmptyString);
+ virtual ~wxStaticBoxSizer();
void RecalcSizes();
wxSize CalcMin();
// override to hide/show the static box as well
virtual void ShowItems (bool show);
+ virtual bool Detach( wxWindow *window );
+ virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
+ virtual bool Detach( int index ) { return wxBoxSizer::Detach(index); }
+
protected:
wxStaticBox *m_staticBox;
// is set to _("Save") and m_buttonNegative is set to _("Don't Save")
// I wouldn't add any other hacks like that into here,
// but this one I can see being useful.
- void Finalise();
+ void Realize();
wxButton *GetAffirmativeButton() const { return m_buttonAffirmative; }
wxButton *GetApplyButton() const { return m_buttonApply; }
class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
{
public:
+#if WXWIN_COMPATIBILITY_2_6
wxDEPRECATED( wxBookCtrlSizer(wxBookCtrlBase *bookctrl) );
+#endif // WXWIN_COMPATIBILITY_2_6
wxBookCtrlBase *GetControl() const { return m_bookctrl; }
class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
{
public:
+#if WXWIN_COMPATIBILITY_2_6
wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) );
+#endif // WXWIN_COMPATIBILITY_2_6
wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }
// inline functions implementation
// ----------------------------------------------------------------------------
+inline wxSizerItem*
+wxSizer::Add( wxSizerItem *item )
+{
+ return Insert( m_children.GetCount(), item );
+}
+
inline wxSizerItem*
wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
{
return Add( new wxSizerItem(sizer, flags) );
}
-inline wxSizerItem*
-wxSizer::Add( wxSizerItem *item )
-{
- return Insert( m_children.GetCount(), item );
-}
-
inline wxSizerItem*
wxSizer::AddSpacer(int size)
{
return Add(0, 0, prop);
}
+inline wxSizerItem*
+wxSizer::Prepend( wxSizerItem *item )
+{
+ return Insert( 0, item );
+}
+
inline wxSizerItem*
wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
{
return Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
}
-inline wxSizerItem*
-wxSizer::Prepend( wxSizerItem *item )
-{
- return Insert( 0, item );
-}
-
inline wxSizerItem*
wxSizer::PrependSpacer(int size)
{
#endif // __WXSIZER_H__
-
projects / wxWidgets.git / blobdiff