src/generic/collpaneg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/collpaneg.cpp
   3 // Purpose:     wxGenericCollapsiblePane
   4 // Author:      Francesco Montorsi
   5 // Modified By:
   6 // Created:     8/10/2006
   7 // Id:          $Id$
   8 // Copyright:   (c) Francesco Montorsi
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12
  13 // ----------------------------------------------------------------------------
  14 // headers
  15 // ----------------------------------------------------------------------------
  16
  17 // For compilers that support precompilation, includes "wx.h".
  18 #include "wx/wxprec.h"
  19
  20 #ifdef __BORLANDC__
  21     #pragma hdrstop
  22 #endif
  23
  24 #include "wx/defs.h"
  25
  26 #if wxUSE_COLLPANE && wxUSE_BUTTON && wxUSE_STATLINE
  27
  28 #include "wx/collpane.h"
  29
  30 #ifndef WX_PRECOMP
  31     #include "wx/toplevel.h"
  32     #include "wx/button.h"
  33     #include "wx/sizer.h"
  34     #include "wx/panel.h"
  35 #endif // !WX_PRECOMP
  36
  37 #include "wx/statline.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // constants
  41 // ----------------------------------------------------------------------------
  42
  43 // ============================================================================
  44 // implementation
  45 // ============================================================================
  46
  47 const char wxCollapsiblePaneNameStr[] = "collapsiblePane";
  48
  49 //-----------------------------------------------------------------------------
  50 // wxGenericCollapsiblePane
  51 //-----------------------------------------------------------------------------
  52
  53 wxDEFINE_EVENT( wxEVT_COMMAND_COLLPANE_CHANGED, wxCollapsiblePaneEvent );
  54 IMPLEMENT_DYNAMIC_CLASS(wxGenericCollapsiblePane, wxControl)
  55 IMPLEMENT_DYNAMIC_CLASS(wxCollapsiblePaneEvent, wxCommandEvent)
  56
  57 BEGIN_EVENT_TABLE(wxGenericCollapsiblePane, wxControl)
  58     EVT_BUTTON(wxID_ANY, wxGenericCollapsiblePane::OnButton)
  59     EVT_SIZE(wxGenericCollapsiblePane::OnSize)
  60
  61     WX_EVENT_TABLE_CONTROL_CONTAINER(wxGenericCollapsiblePane)
  62 END_EVENT_TABLE()
  63
  64 WX_DELEGATE_TO_CONTROL_CONTAINER(wxGenericCollapsiblePane, wxControl)
  65
  66 void wxGenericCollapsiblePane::Init()
  67 {
  68     WX_INIT_CONTROL_CONTAINER();
  69
  70     m_pButton = NULL;
  71     m_pPane = NULL;
  72     m_pStaticLine = NULL;
  73     m_sz = NULL;
  74 }
  75
  76 bool wxGenericCollapsiblePane::Create(wxWindow *parent,
  77                                       wxWindowID id,
  78                                       const wxString& label,
  79                                       const wxPoint& pos,
  80                                       const wxSize& size,
  81                                       long style,
  82                                       const wxValidator& val,
  83                                       const wxString& name)
  84 {
  85     if ( !wxControl::Create(parent, id, pos, size, style, val, name) )
  86         return false;
  87
  88     m_strLabel = label;
  89
  90 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
  91     // on Mac we use the disclosure triangle
  92     // we need a light gray line above and below, lets approximate with the frame
  93     m_pStaticLine = NULL;
  94     m_pButton = new wxDisclosureTriangle( this, wxID_ANY, GetBtnLabel(),
  95                                          wxDefaultPosition, wxDefaultSize, wxSIMPLE_BORDER );
  96     m_pButton->SetBackgroundColour( wxColour( 221, 226, 239 ) );
  97     m_sz = new wxBoxSizer(wxHORIZONTAL);
  98     // m_sz->Add(4,4); where shall we put it?
  99     m_sz->Add( m_pButton, 1);
 100 #else
 101     // create children and lay them out using a wxBoxSizer
 102     // (so that we automatically get RTL features)
 103     m_pButton = new wxButton(this, wxID_ANY, GetBtnLabel(), wxPoint(0, 0),
 104                              wxDefaultSize, wxBU_EXACTFIT);
 105     m_pStaticLine = new wxStaticLine(this, wxID_ANY);
 106     // on other platforms we put the static line and the button horizontally
 107     m_sz = new wxBoxSizer(wxHORIZONTAL);
 108     m_sz->Add(m_pButton, 0, wxLEFT|wxTOP|wxBOTTOM, GetBorder());
 109     m_sz->Add(m_pStaticLine, 1, wxALIGN_CENTER|wxLEFT|wxRIGHT, GetBorder());
 110 #endif
 111
 112     // FIXME: at least under wxCE and wxGTK1 the background is black if we don't do
 113     //        this, no idea why...
 114 #if defined(__WXWINCE__) || defined(__WXGTK__)
 115     SetBackgroundColour(parent->GetBackgroundColour());
 116 #endif
 117
 118     // do not set sz as our sizers since we handle the pane window without using sizers
 119     m_pPane = new wxPanel(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 120                           wxTAB_TRAVERSAL|wxNO_BORDER, wxT("wxCollapsiblePanePane") );
 121
 122     // start as collapsed:
 123     m_pPane->Hide();
 124
 125     return true;
 126 }
 127
 128 wxGenericCollapsiblePane::~wxGenericCollapsiblePane()
 129 {
 130     if (m_pButton)
 131         m_pButton->SetContainingSizer(NULL);
 132
 133     if (m_pStaticLine)
 134         m_pStaticLine->SetContainingSizer(NULL);
 135
 136     // our sizer is not deleted automatically since we didn't use SetSizer()!
 137     wxDELETE(m_sz);
 138 }
 139
 140 wxSize wxGenericCollapsiblePane::DoGetBestSize() const
 141 {
 142     // NB: do not use GetSize() but rather GetMinSize()
 143     wxSize sz = m_sz->GetMinSize();
 144
 145     // when expanded, we need more vertical space
 146     if ( IsExpanded() )
 147     {
 148         sz.SetWidth(wxMax( sz.GetWidth(), m_pPane->GetBestSize().x ));
 149         sz.SetHeight(sz.y + GetBorder() + m_pPane->GetBestSize().y);
 150     }
 151
 152     return sz;
 153 }
 154
 155 wxString wxGenericCollapsiblePane::GetBtnLabel() const
 156 {
 157     // on mac the triangle indicates the state, no string change
 158 #ifdef __WXMAC__
 159     return m_strLabel;
 160 #else
 161     return m_strLabel + (IsCollapsed() ? wxT(" >>") : wxT(" <<"));
 162 #endif
 163 }
 164
 165 void wxGenericCollapsiblePane::OnStateChange(const wxSize& sz)
 166 {
 167     // minimal size has priority over the best size so set here our min size
 168 //    SetMinSize(sz);
 169     SetSize(sz);
 170
 171     if (this->HasFlag(wxCP_NO_TLW_RESIZE))
 172     {
 173         // the user asked to explicitely handle the resizing itself...
 174         return;
 175     }
 176
 177
 178     wxTopLevelWindow *top =
 179         wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow);
 180     if ( !top )
 181         return;
 182
 183     wxSizer *sizer = top->GetSizer();
 184     if ( !sizer )
 185         return;
 186
 187     const wxSize newBestSize = sizer->ComputeFittingClientSize(top);
 188     top->SetMinClientSize(newBestSize);
 189
 190     // we shouldn't attempt to resize a maximized window, whatever happens
 191     if ( !top->IsMaximized() )
 192         top->SetClientSize(newBestSize);
 193 }
 194
 195 void wxGenericCollapsiblePane::Collapse(bool collapse)
 196 {
 197     // optimization
 198     if ( IsCollapsed() == collapse )
 199         return;
 200
 201     // update our state
 202     m_pPane->Show(!collapse);
 203
 204     // update button label
 205 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)
 206     m_pButton->SetOpen( !collapse );
 207 #else
 208     // NB: this must be done after updating our "state"
 209     m_pButton->SetLabel(GetBtnLabel());
 210 #endif
 211
 212
 213     OnStateChange(GetBestSize());
 214 }
 215
 216 void wxGenericCollapsiblePane::SetLabel(const wxString &label)
 217 {
 218     m_strLabel = label;
 219 #ifdef __WXMAC__
 220     m_pButton->SetLabel(GetBtnLabel());
 221 #else
 222     m_pButton->SetLabel(GetBtnLabel());
 223     m_pButton->SetInitialSize();
 224 #endif
 225
 226     Layout();
 227 }
 228
 229 bool wxGenericCollapsiblePane::Layout()
 230 {
 231 #ifdef __WXMAC__
 232     if (!m_pButton || !m_pPane || !m_sz)
 233         return false;     // we need to complete the creation first!
 234 #else
 235     if (!m_pButton || !m_pStaticLine || !m_pPane || !m_sz)
 236         return false;     // we need to complete the creation first!
 237 #endif
 238
 239     wxSize oursz(GetSize());
 240
 241     // move & resize the button and the static line
 242     m_sz->SetDimension(0, 0, oursz.GetWidth(), m_sz->GetMinSize().GetHeight());
 243     m_sz->Layout();
 244
 245     if ( IsExpanded() )
 246     {
 247         // move & resize the container window
 248         int yoffset = m_sz->GetSize().GetHeight() + GetBorder();
 249         m_pPane->SetSize(0, yoffset,
 250                         oursz.x, oursz.y - yoffset);
 251
 252         // this is very important to make the pane window layout show correctly
 253         m_pPane->Layout();
 254     }
 255
 256     return true;
 257 }
 258
 259 int wxGenericCollapsiblePane::GetBorder() const
 260 {
 261 #if defined( __WXMAC__ )
 262     return 6;
 263 #elif defined(__WXMSW__)
 264     wxASSERT(m_pButton);
 265     return m_pButton->ConvertDialogToPixels(wxSize(2, 0)).x;
 266 #else
 267     return 5;
 268 #endif
 269 }
 270
 271
 272
 273 //-----------------------------------------------------------------------------
 274 // wxGenericCollapsiblePane - event handlers
 275 //-----------------------------------------------------------------------------
 276
 277 void wxGenericCollapsiblePane::OnButton(wxCommandEvent& event)
 278 {
 279     if ( event.GetEventObject() != m_pButton )
 280     {
 281         event.Skip();
 282         return;
 283     }
 284
 285     Collapse(!IsCollapsed());
 286
 287     // this change was generated by the user - send the event
 288     wxCollapsiblePaneEvent ev(this, GetId(), IsCollapsed());
 289     GetEventHandler()->ProcessEvent(ev);
 290 }
 291
 292 void wxGenericCollapsiblePane::OnSize(wxSizeEvent& WXUNUSED(event))
 293 {
 294 #if 0       // for debug only
 295     wxClientDC dc(this);
 296     dc.SetPen(*wxBLACK_PEN);
 297     dc.SetBrush(*wxTRANSPARENT_BRUSH);
 298     dc.DrawRectangle(wxPoint(0,0), GetSize());
 299     dc.SetPen(*wxRED_PEN);
 300     dc.DrawRectangle(wxPoint(0,0), GetBestSize());
 301 #endif
 302
 303     Layout();
 304 }
 305
 306 #endif // wxUSE_COLLPANE && wxUSE_BUTTON && wxUSE_STATLINE