Added wxGridBagSizer, a grid sizer where item positions can be

specified and row/col spanning is allowed.

Updated docs, the layout sample, files.bkl, and updated makefiles.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24416 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2003-11-06 01:31:44 +00:00
parent 5d1000e7f1
commit 20b35a6916
32 changed files with 2198 additions and 259 deletions

631
src/common/gbsizer.cpp Normal file
View File

@@ -0,0 +1,631 @@
/////////////////////////////////////////////////////////////////////////////
// Name: gbsizer.cpp
// Purpose: wxGridBagSizer: A sizer that can lay out items in a grid,
// with items at specified cells, and with the option of row
// and/or column spanning
//
// Author: Robin Dunn
// Created: 03-Nov-2003
// RCS-ID: $Id$
// Copyright: (c) Robin Dunn
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "gbsizer.h"
#endif
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#include "wx/gbsizer.h"
//---------------------------------------------------------------------------
IMPLEMENT_CLASS(wxGBSizerItem, wxSizerItem)
IMPLEMENT_CLASS(wxGridBagSizer, wxFlexGridSizer)
const wxGBSpan wxDefaultSpan;
//---------------------------------------------------------------------------
// wxGBSizerItem
//---------------------------------------------------------------------------
wxGBSizerItem::wxGBSizerItem( int width,
int height,
const wxGBPosition& pos,
const wxGBSpan& span,
int flag,
int border,
wxObject* userData)
: wxSizerItem(width, height, 0, flag, border, userData),
m_pos(pos),
m_span(span),
m_sizer(NULL)
{
}
wxGBSizerItem::wxGBSizerItem( wxWindow *window,
const wxGBPosition& pos,
const wxGBSpan& span,
int flag,
int border,
wxObject* userData )
: wxSizerItem(window, 0, flag, border, userData),
m_pos(pos),
m_span(span),
m_sizer(NULL)
{
}
wxGBSizerItem::wxGBSizerItem( wxSizer *sizer,
const wxGBPosition& pos,
const wxGBSpan& span,
int flag,
int border,
wxObject* userData )
: wxSizerItem(sizer, 0, flag, border, userData),
m_pos(pos),
m_span(span),
m_sizer(NULL)
{
}
//---------------------------------------------------------------------------
void wxGBSizerItem::GetPos(int& row, int& col) const
{
row = m_pos.GetRow();
col = m_pos.GetCol();
}
void wxGBSizerItem::GetSpan(int& rowspan, int& colspan) const
{
rowspan = m_span.GetRowspan();
colspan = m_span.GetColspan();
}
bool wxGBSizerItem::SetPos( const wxGBPosition& pos )
{
if (m_sizer)
{
wxCHECK_MSG( !m_sizer->CheckForIntersection(pos, m_span, this), false,
wxT("An item is already at that position") );
}
m_pos = pos;
return true;
}
bool wxGBSizerItem::SetSpan( const wxGBSpan& span )
{
if (m_sizer)
{
wxCHECK_MSG( !m_sizer->CheckForIntersection(m_pos, span, this), false,
wxT("An item is already at that position") );
}
m_span = span;
return true;
}
inline bool InRange(int val, int min, int max)
{
return (val >= min && val <= max);
}
bool wxGBSizerItem::Intersects(const wxGBSizerItem& other)
{
return Intersects(other.GetPos(), other.GetSpan());
}
bool wxGBSizerItem::Intersects(const wxGBPosition& pos, const wxGBSpan& span)
{
int row, col, endrow, endcol;
int otherrow, othercol, otherendrow, otherendcol;
GetPos(row, col);
GetEndPos(endrow, endcol);
otherrow = pos.GetRow();
othercol = pos.GetCol();
otherendrow = otherrow + span.GetRowspan() - 1;
otherendcol = othercol + span.GetColspan() - 1;
// is the other item's start or end in the range of this one?
if (( InRange(otherrow, row, endrow) && InRange(othercol, col, endcol) ) ||
( InRange(otherendrow, row, endrow) && InRange(otherendcol, col, endcol) ))
return true;
// is this item's start or end in the range of the other one?
if (( InRange(row, otherrow, otherendrow) && InRange(col, othercol, otherendcol) ) ||
( InRange(endrow, otherrow, otherendrow) && InRange(endcol, othercol, otherendcol) ))
return true;
return false;
}
void wxGBSizerItem::GetEndPos(int& row, int& col)
{
row = m_pos.GetRow() + m_span.GetRowspan() - 1;
col = m_pos.GetCol() + m_span.GetColspan() - 1;
}
//---------------------------------------------------------------------------
// wxGridBagSizer
//---------------------------------------------------------------------------
wxGridBagSizer::wxGridBagSizer(int vgap, int hgap )
: wxFlexGridSizer(1, vgap, hgap),
m_emptyCellSize(10,20)
{
}
bool wxGridBagSizer::Add( wxWindow *window,
const wxGBPosition& pos, const wxGBSpan& span,
int flag, int border, wxObject* userData )
{
wxGBSizerItem* item = new wxGBSizerItem(window, pos, span, flag, border, userData);
if ( Add(item) )
return true;
else
{
delete item;
return false;
}
}
bool wxGridBagSizer::Add( wxSizer *sizer,
const wxGBPosition& pos, const wxGBSpan& span,
int flag, int border, wxObject* userData )
{
wxGBSizerItem* item = new wxGBSizerItem(sizer, pos, span, flag, border, userData);
if ( Add(item) )
return true;
else
{
delete item;
return false;
}
}
bool wxGridBagSizer::Add( int width, int height,
const wxGBPosition& pos, const wxGBSpan& span,
int flag, int border, wxObject* userData )
{
wxGBSizerItem* item = new wxGBSizerItem(width, height, pos, span, flag, border, userData);
if ( Add(item) )
return true;
else
{
delete item;
return false;
}
}
bool wxGridBagSizer::Add( wxGBSizerItem *item )
{
m_children.Append(item);
item->SetSizer(this);
if ( item->GetWindow() )
item->GetWindow()->SetContainingSizer( this );
return true;
}
//---------------------------------------------------------------------------
wxGBPosition wxGridBagSizer::GetItemPosition(wxWindow *window)
{
wxGBPosition badpos(-1,-1);
wxGBSizerItem* item = FindItem(window);
wxCHECK_MSG(item, badpos, wxT("Failed to find item."));
return item->GetPos();
}
wxGBPosition wxGridBagSizer::GetItemPosition(wxSizer *sizer)
{
wxGBPosition badpos(-1,-1);
wxGBSizerItem* item = FindItem(sizer);
wxCHECK_MSG(item, badpos, wxT("Failed to find item."));
return item->GetPos();
}
wxGBPosition wxGridBagSizer::GetItemPosition(size_t index)
{
wxGBPosition badpos(-1,-1);
wxSizerItemList::compatibility_iterator node = m_children.Item( index );
wxCHECK_MSG( node, badpos, _T("Failed to find item.") );
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
return item->GetPos();
}
bool wxGridBagSizer::SetItemPosition(wxWindow *window, const wxGBPosition& pos)
{
wxGBSizerItem* item = FindItem(window);
wxCHECK_MSG(item, false, wxT("Failed to find item."));
return item->SetPos(pos);
}
bool wxGridBagSizer::SetItemPosition(wxSizer *sizer, const wxGBPosition& pos)
{
wxGBSizerItem* item = FindItem(sizer);
wxCHECK_MSG(item, false, wxT("Failed to find item."));
return item->SetPos(pos);
}
bool wxGridBagSizer::SetItemPosition(size_t index, const wxGBPosition& pos)
{
wxSizerItemList::compatibility_iterator node = m_children.Item( index );
wxCHECK_MSG( node, false, _T("Failed to find item.") );
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
return item->SetPos(pos);
}
wxGBSpan wxGridBagSizer::GetItemSpan(wxWindow *window)
{
wxGBSpan badspan(-1,-1);
wxGBSizerItem* item = FindItem(window);
wxCHECK_MSG( item, badspan, _T("Failed to find item.") );
return item->GetSpan();
}
wxGBSpan wxGridBagSizer::GetItemSpan(wxSizer *sizer)
{
wxGBSpan badspan(-1,-1);
wxGBSizerItem* item = FindItem(sizer);
wxCHECK_MSG( item, badspan, _T("Failed to find item.") );
return item->GetSpan();
}
wxGBSpan wxGridBagSizer::GetItemSpan(size_t index)
{
wxGBSpan badspan(-1,-1);
wxSizerItemList::compatibility_iterator node = m_children.Item( index );
wxCHECK_MSG( node, badspan, _T("Failed to find item.") );
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
return item->GetSpan();
}
bool wxGridBagSizer::SetItemSpan(wxWindow *window, const wxGBSpan& span)
{
wxGBSizerItem* item = FindItem(window);
wxCHECK_MSG(item, false, wxT("Failed to find item."));
return item->SetSpan(span);
}
bool wxGridBagSizer::SetItemSpan(wxSizer *sizer, const wxGBSpan& span)
{
wxGBSizerItem* item = FindItem(sizer);
wxCHECK_MSG(item, false, wxT("Failed to find item."));
return item->SetSpan(span);
}
bool wxGridBagSizer::SetItemSpan(size_t index, const wxGBSpan& span)
{
wxSizerItemList::compatibility_iterator node = m_children.Item( index );
wxCHECK_MSG( node, false, _T("Failed to find item.") );
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
return item->SetSpan(span);
}
wxGBSizerItem* wxGridBagSizer::FindItem(wxWindow* window)
{
wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
while (node)
{
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
if ( item->GetWindow() == window )
return item;
node = node->GetNext();
}
return NULL;
}
wxGBSizerItem* wxGridBagSizer::FindItem(wxSizer* sizer)
{
wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
while (node)
{
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
if ( item->GetSizer() == sizer )
return item;
node = node->GetNext();
}
return NULL;
}
wxGBSizerItem* wxGridBagSizer::FindItemAtPosition(const wxGBPosition& pos)
{
wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
while (node)
{
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
if ( item->Intersects(pos, wxDefaultSpan) )
return item;
node = node->GetNext();
}
return NULL;
}
wxGBSizerItem* wxGridBagSizer::FindItemWithData(const wxObject* userData)
{
wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
while (node)
{
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
if ( item->GetUserData() == userData )
return item;
node = node->GetNext();
}
return NULL;
}
//---------------------------------------------------------------------------
// Figure out what all the min row heights and col widths are, and calculate
// min size from that.
wxSize wxGridBagSizer::CalcMin()
{
int idx;
if (m_children.GetCount() == 0)
return m_emptyCellSize;
m_rowHeights.Empty();
m_colWidths.Empty();
wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
while (node)
{
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
if ( item->IsShown() )
{
int row, col, endrow, endcol;
item->GetPos(row, col);
item->GetEndPos(endrow, endcol);
// fill heights and widths upto this item if needed
while ( m_rowHeights.GetCount() <= (size_t)endrow )
m_rowHeights.Add(m_emptyCellSize.GetHeight());
while ( m_colWidths.GetCount() <= (size_t)endcol )
m_colWidths.Add(m_emptyCellSize.GetWidth());
// See if this item increases the size of its row(s) or col(s)
wxSize size(item->CalcMin());
for (idx=row; idx <= endrow; idx++)
m_rowHeights[idx] = wxMax(m_rowHeights[idx], size.GetHeight() / (endrow-row+1));
for (idx=col; idx <= endcol; idx++)
m_colWidths[idx] = wxMax(m_colWidths[idx], size.GetWidth() / (endcol-col+1));
}
node = node->GetNext();
}
AdjustForFlexDirection();
// Now traverse the heights and widths arrays calcing the totals, including gaps
int width = 0;
int ncols = m_colWidths.GetCount();
for (idx=0; idx < ncols; idx++)
width += m_colWidths[idx] + ( idx == ncols-1 ? 0 : m_hgap );
int height = 0;
int nrows = m_rowHeights.GetCount();
for (idx=0; idx < nrows; idx++)
height += m_rowHeights[idx] + ( idx == nrows-1 ? 0 : m_vgap );
return wxSize(width, height);
}
void wxGridBagSizer::RecalcSizes()
{
if (m_children.GetCount() == 0)
return;
// Calculates minsize and populates m_rowHeights and m_colWidths
wxSize minsz( CalcMin() );
wxPoint pt( GetPosition() );
wxSize sz( GetSize() );
int nrows = m_rowHeights.GetCount();
int ncols = m_colWidths.GetCount();
int idx, width, height;
AdjustForGrowables(sz, minsz, nrows, ncols);
// Find the start positions on the window of the rows and columns
wxArrayInt rowpos;
rowpos.Add(0, nrows);
int y = pt.y;
for (idx=0; idx < nrows; idx++)
{
height = m_rowHeights[idx] + m_vgap;
rowpos[idx] = y;
y += height;
}
wxArrayInt colpos;
colpos.Add(0, ncols);
int x = pt.x;
for (idx=0; idx < ncols; idx++)
{
width = m_colWidths[idx] + m_hgap;
colpos[idx] = x;
x += width;
}
// Now iterate the children, setting each child's dimensions
wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
while (node)
{
int row, col, endrow, endcol;
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
item->GetPos(row, col);
item->GetEndPos(endrow, endcol);
height = 0;
for(idx=row; idx <= endrow; idx++)
height += m_rowHeights[idx] + m_vgap;
width = 0;
for (idx=col; idx <= endcol; idx++)
width += m_colWidths[idx] + m_hgap;
SetItemBounds(item, colpos[col], rowpos[row], width, height);
node = node->GetNext();
}
}
//---------------------------------------------------------------------------
bool wxGridBagSizer::CheckForIntersection(wxGBSizerItem* item, wxGBSizerItem* excludeItem)
{
return CheckForIntersection(item->GetPos(), item->GetSpan(), excludeItem);
}
bool wxGridBagSizer::CheckForIntersection(const wxGBPosition& pos, const wxGBSpan& span, wxGBSizerItem* excludeItem)
{
wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
while (node)
{
wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
node = node->GetNext();
if ( excludeItem && item == excludeItem )
continue;
if ( item->Intersects(pos, span) )
return true;
}
return false;
}
// Assumes a 10x10 grid, and returns the first empty cell found. This is
// really stupid but it is only used by the Add methods that match the base
// class virtuals, which should normally not be used anyway...
wxGBPosition wxGridBagSizer::FindEmptyCell()
{
int row, col;
for (row=0; row<10; row++)
for (col=0; col<10; col++)
{
wxGBPosition pos(row, col);
if ( !CheckForIntersection(pos, wxDefaultSpan) )
return pos;
}
return wxGBPosition(-1, -1);
}
//---------------------------------------------------------------------------
// The Add base class virtuals should not be used with this class, but
// we'll try to make them automatically select a location for the item
// anyway.
void wxGridBagSizer::Add( wxWindow *window, int, int flag, int border, wxObject* userData )
{
Add(window, FindEmptyCell(), wxDefaultSpan, flag, border, userData);
}
void wxGridBagSizer::Add( wxSizer *sizer, int, int flag, int border, wxObject* userData )
{
Add(sizer, FindEmptyCell(), wxDefaultSpan, flag, border, userData);
}
void wxGridBagSizer::Add( int width, int height, int, int flag, int border, wxObject* userData )
{
Add(width, height, FindEmptyCell(), wxDefaultSpan, flag, border, userData);
}
// The Insert nad Prepend base class virtuals that are not appropriate for
// this class and should not be used. Their implementation in this class
// simply fails.
void wxGridBagSizer::Add( wxSizerItem *item )
{ wxFAIL_MSG(wxT("Invalid Add form called.")); }
void wxGridBagSizer::Prepend( wxWindow *, int, int, int, wxObject* )
{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
void wxGridBagSizer::Prepend( wxSizer *, int, int, int, wxObject* )
{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
void wxGridBagSizer::Prepend( int, int, int, int, int, wxObject* )
{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
void wxGridBagSizer::Prepend( wxSizerItem * )
{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
void wxGridBagSizer::Insert( size_t, wxWindow *, int, int, int, wxObject* )
{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
void wxGridBagSizer::Insert( size_t, wxSizer *, int, int, int, wxObject* )
{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
void wxGridBagSizer::Insert( size_t, int, int, int, int, int, wxObject* )
{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
void wxGridBagSizer::Insert( size_t, wxSizerItem * )
{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------