src/gtk/collpane.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/collpane.cpp
   3 // Purpose:     wxCollapsiblePane
   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 #if wxUSE_COLLPANE && defined(__WXGTK24__) && !defined(__WXUNIVERSAL__)
  21
  22 #include "wx/collpane.h"
  23 #include "wx/toplevel.h"
  24 #include "wx/sizer.h"
  25 #include "wx/panel.h"
  26
  27 #include "wx/gtk/private.h"
  28 #include "wx/gtk/win_gtk.h"
  29
  30 #include <gtk/gtkexpander.h>
  31
  32 // ============================================================================
  33 // implementation
  34 // ============================================================================
  35
  36 //-----------------------------------------------------------------------------
  37 // "notify::expanded" signal
  38 //-----------------------------------------------------------------------------
  39
  40 extern "C" {
  41
  42 static void gtk_collapsiblepane_expanded_callback (GObject    *object,
  43                                                     GParamSpec *param_spec,
  44                                                     wxCollapsiblePane *p)
  45 {
  46     // NB: unlike for the "activate" signal, when this callback is called, if
  47     //     we try to query the "collapsed" status through p->IsCollapsed(), we
  48     //     get the right value. I.e. here p->IsCollapsed() will return false if
  49     //     this callback has been called at the end of a collapsed->expanded
  50     //     transition and viceversa. Inside the "activate" signal callback
  51     //     p->IsCollapsed() would return the wrong value!
  52
  53     wxSize sz;
  54     if ( p->IsExpanded() )
  55     {
  56         // NB: we cannot use the p->GetBestSize() or p->GetMinSize() functions
  57         //     here as they would return the size for the collapsed expander
  58         //     even if the collapsed->expanded transition has already been
  59         //     completed; we solve this problem doing:
  60
  61         sz = p->m_szCollapsed;
  62
  63         wxSize panesz = p->GetPane()->GetBestSize();
  64         sz.x = wxMax(sz.x, panesz.x);
  65         sz.y += gtk_expander_get_spacing(GTK_EXPANDER(p->m_widget)) + panesz.y;
  66     }
  67     else // collapsed
  68     {
  69         // same problem described above: using p->Get[Best|Min]Size() here we
  70         // would get the size of the control when it is expanded even if the
  71         // expanded->collapsed transition should be complete now...
  72         // So, we use the size cached at control-creation time...
  73         sz = p->m_szCollapsed;
  74     }
  75
  76     // VERY IMPORTANT:
  77     // just calling
  78     //          p->OnStateChange(sz);
  79     // here would work work BUT:
  80     //     1) in the expanded->collapsed transition it provokes a lot of flickering
  81     //     2) in the collapsed->expanded transition using the "Change status" wxButton
  82     //        in samples/collpane application some strange warnings would be generated
  83     //        by the "clearlooks" theme, if that's your theme.
  84     //
  85     // So we prefer to use some GTK+ native optimized calls, which prevent too many resize
  86     // calculations to happen. Note that the following code has been very carefully designed
  87     // and tested - be VERY careful when changing it!
  88
  89     // 1) need to update our size hints
  90     // NB: this function call won't actually do any long operation
  91     //     (redraw/relayouting/resizing) so that it's flicker-free
  92     p->SetMinSize(sz);
  93
  94     if (p->HasFlag(wxCP_NO_TLW_RESIZE))
  95     {
  96         // the user asked to explicitely handle the resizing itself...
  97         return;
  98     }
  99
 100     wxTopLevelWindow *
 101         top = wxDynamicCast(wxGetTopLevelParent(p), wxTopLevelWindow);
 102     if ( top && top->GetSizer() )
 103     {
 104         // 2) recalculate minimal size of the top window
 105         wxSize sz = top->GetSizer()->CalcMin();
 106
 107         if (top->m_mainWidget)
 108         {
 109             // 3) MAGIC HACK: if you ever used GtkExpander in a GTK+ program you know
 110             //    that this magic call is required to make it possible to shrink the
 111             //    top level window in the expanded->collapsed transition.
 112             //    This may be sometimes undesired but *is* necessary and if you look
 113             //    carefully, all GTK+ programs using GtkExpander perform this trick
 114             //    (e.g. the standard "open file" dialog of GTK+>=2.4 is not resizeable
 115             //     when the expander is collapsed!)
 116             gtk_window_set_resizable (GTK_WINDOW (top->m_widget), p->IsExpanded());
 117
 118             // 4) set size hints: note that this code has been taken and adapted
 119             //    from src/gtk/toplevel.cpp
 120             GdkGeometry geom;
 121
 122             geom.min_width = sz.x;
 123             geom.min_height = sz.y;
 124
 125             gtk_window_set_geometry_hints( GTK_WINDOW(top->m_widget),
 126                                            (GtkWidget*) NULL,
 127                                            &geom,
 128                                            GDK_HINT_MIN_SIZE );
 129
 130             // 5) set size: also this code has been adapted from src/gtk/toplevel.cpp
 131             //    to do the size changes immediately and not delaying them in the idle
 132             //    time
 133             top->m_width = sz.x;
 134             top->m_height = sz.y;
 135
 136             int client_x = top->m_miniEdge;
 137             int client_y = top->m_miniEdge + top->m_miniTitle;
 138             int client_w = top->m_width - 2*top->m_miniEdge;
 139             int client_h = top->m_height - 2*top->m_miniEdge - top->m_miniTitle;
 140             if (client_w < 0)
 141                 client_w = 0;
 142             if (client_h < 0)
 143                 client_h = 0;
 144
 145             gtk_pizza_set_size( GTK_PIZZA(top->m_mainWidget),
 146                                 top->m_wxwindow,
 147                                 client_x, client_y, client_w, client_h );
 148
 149             gtk_widget_set_size_request( top->m_wxwindow, sz.x, sz.y );
 150
 151         }
 152     }
 153
 154     if ( p->m_bIgnoreNextChange )
 155     {
 156         // change generated programmatically - do not send an event!
 157         p->m_bIgnoreNextChange = false;
 158         return;
 159     }
 160
 161     // fire an event
 162     wxCollapsiblePaneEvent ev(p, p->GetId(), p->IsCollapsed());
 163     p->GetEventHandler()->ProcessEvent(ev);
 164 }
 165 }
 166
 167 static void
 168 gtk_collapsiblepane_insert_callback(wxWindowGTK* parent, wxWindowGTK* child)
 169 {
 170     // this callback should be used only once to insert the "pane" into the
 171     // GtkExpander widget. wxGenericCollapsiblePane::DoAddChild() will check if
 172     // it has been called only once (and in any case we would get a warning
 173     // from the following call as GtkExpander is a GtkBin and can contain only
 174     // a single child!).
 175     gtk_container_add (GTK_CONTAINER (parent->m_widget), child->m_widget);
 176 }
 177
 178 //-----------------------------------------------------------------------------
 179 // wxCollapsiblePane
 180 //-----------------------------------------------------------------------------
 181
 182 IMPLEMENT_DYNAMIC_CLASS(wxCollapsiblePane, wxGenericCollapsiblePane)
 183
 184 BEGIN_EVENT_TABLE(wxCollapsiblePane, wxGenericCollapsiblePane)
 185     EVT_SIZE(wxCollapsiblePane::OnSize)
 186 END_EVENT_TABLE()
 187
 188 bool wxCollapsiblePane::Create(wxWindow *parent,
 189                                wxWindowID id,
 190                                const wxString& label,
 191                                const wxPoint& pos,
 192                                const wxSize& size,
 193                                long style,
 194                                const wxValidator& val,
 195                                const wxString& name)
 196 {
 197     if (gtk_check_version(2,4,0))
 198         return wxGenericCollapsiblePane::Create(parent, id, label,
 199                                                 pos, size, style, val, name);
 200
 201     m_needParent = true;
 202     m_bIgnoreNextChange = false;
 203
 204     if ( !PreCreation( parent, pos, size ) ||
 205           !wxControl::CreateBase(parent, id, pos, size, style, val, name) )
 206     {
 207         wxFAIL_MSG( wxT("wxCollapsiblePane creation failed") );
 208         return false;
 209     }
 210
 211     m_widget =
 212         gtk_expander_new_with_mnemonic(wxGTK_CONV(GTKConvertMnemonics(label)));
 213
 214     // see the gtk_collapsiblepane_expanded_callback comments to understand why
 215     // we connect to the "notify::expanded" signal instead of the more common
 216     // "activate" one
 217     g_signal_connect(m_widget, "notify::expanded",
 218                      G_CALLBACK(gtk_collapsiblepane_expanded_callback), this);
 219
 220     // before creating m_pPane, we need to makesure our own insert callback
 221     // will be used
 222     m_insertCallback = gtk_collapsiblepane_insert_callback;
 223
 224     // this the real "pane"
 225     m_pPane = new wxPanel(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 226                            wxTAB_TRAVERSAL|wxNO_BORDER);
 227
 228     gtk_widget_show(m_widget);
 229     m_parent->DoAddChild( this );
 230
 231     PostCreation(size);
 232
 233     // remember the size of this control when it's collapsed
 234     m_szCollapsed = GetBestSize();
 235
 236     return true;
 237 }
 238
 239 wxSize wxCollapsiblePane::DoGetBestSize() const
 240 {
 241     if (!gtk_check_version(2,4,0))
 242     {
 243         wxASSERT_MSG( m_widget, wxT("DoGetBestSize called before creation") );
 244
 245         GtkRequisition req;
 246         req.width = 2;
 247         req.height = 2;
 248         (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
 249                 (m_widget, &req );
 250
 251         // notice that we do not cache our best size here as it changes
 252         // all times the user expands/hide our pane
 253         return wxSize(req.width, req.height);
 254     }
 255
 256     return wxGenericCollapsiblePane::DoGetBestSize();
 257 }
 258
 259 void wxCollapsiblePane::Collapse(bool collapse)
 260 {
 261     if (!gtk_check_version(2,4,0))
 262     {
 263         // optimization
 264         if (IsCollapsed() == collapse)
 265             return;
 266
 267         // do not send event in next signal handler call
 268         m_bIgnoreNextChange = true;
 269         gtk_expander_set_expanded(GTK_EXPANDER(m_widget), !collapse);
 270     }
 271     else
 272         wxGenericCollapsiblePane::Collapse(collapse);
 273 }
 274
 275 bool wxCollapsiblePane::IsCollapsed() const
 276 {
 277     if (!gtk_check_version(2,4,0))
 278         return !gtk_expander_get_expanded(GTK_EXPANDER(m_widget));
 279
 280     return wxGenericCollapsiblePane::IsCollapsed();
 281 }
 282
 283 void wxCollapsiblePane::SetLabel(const wxString &str)
 284 {
 285     if (!gtk_check_version(2,4,0))
 286     {
 287         gtk_expander_set_label(GTK_EXPANDER(m_widget), wxGTK_CONV(str));
 288
 289         // FIXME: we need to update our collapsed width in some way but using GetBestSize()
 290         // we may get the size of the control with the pane size summed up if we are expanded!
 291         //m_szCollapsed.x = GetBestSize().x;
 292     }
 293     else
 294         wxGenericCollapsiblePane::SetLabel(str);
 295 }
 296
 297 void wxCollapsiblePane::OnSize(wxSizeEvent &ev)
 298 {
 299 #if 0       // for debug only
 300     wxClientDC dc(this);
 301     dc.SetPen(*wxBLACK_PEN);
 302     dc.SetBrush(*wxTRANSPARENT_BRUSH);
 303     dc.DrawRectangle(wxPoint(0,0), GetSize());
 304     dc.SetPen(*wxRED_PEN);
 305     dc.DrawRectangle(wxPoint(0,0), GetBestSize());
 306 #endif
 307
 308     // here we need to resize the pane window otherwise, even if the GtkExpander container
 309     // is expanded or shrinked, the pane window won't be updated!
 310     m_pPane->SetSize(ev.GetSize().x, ev.GetSize().y - m_szCollapsed.y);
 311
 312     // we need to explicitely call m_pPane->Layout() or else it won't correctly relayout
 313     // (even if SetAutoLayout(true) has been called on it!)
 314     m_pPane->Layout();
 315 }
 316
 317 #endif // wxUSE_COLLPANE && defined(__WXGTK24__) && !defined(__WXUNIVERSAL__)
 318