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