From 550d433e523dc462c62a2346c0fd713a1d5705e8 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 22 Oct 2006 23:10:07 +0000 Subject: [PATCH] cleanup (mainly wrapping lines to be < 80 chars); added IsExpanded() git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42261 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/collpane.tex | 11 ++- include/wx/collpane.h | 9 +- src/generic/collpaneg.cpp | 52 +++++------ src/gtk/collpane.cpp | 174 +++++++++++++++---------------------- 4 files changed, 107 insertions(+), 139 deletions(-) diff --git a/docs/latex/wx/collpane.tex b/docs/latex/wx/collpane.tex index 40774f130f..cfa4a7bd0f 100644 --- a/docs/latex/wx/collpane.tex +++ b/docs/latex/wx/collpane.tex @@ -8,8 +8,6 @@ %% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - - \section{\class{wxCollapsiblePane}}\label{wxcollapsiblepane} A collapsable panel is a container with an embedded button-like control which can be @@ -96,6 +94,12 @@ all the parameters. Returns \true if the pane window is currently hidden. +\membersection{wxCollapsiblePane::IsExpanded}\label{wxcollapsiblepaneisexpanded} + +\constfunc{bool}{IsExpanded}{\void} + +Returns \true if the pane window is currently shown. + \membersection{wxCollapsiblePane::Collapse}\label{wxcollapsiblepanecollapse} @@ -104,11 +108,10 @@ Returns \true if the pane window is currently hidden. Collapses or expands the pane window. - \membersection{wxCollapsiblePane::Expand}\label{wxcollapsiblepaneexpand} \func{void}{Expand}{\void} -Equivalent to {\tt Collapse(false)}. +Same as \texttt{\helpref{Collapse}{wxcollapsiblepanecollapse}(false)}. diff --git a/include/wx/collpane.h b/include/wx/collpane.h index 002e5a3e21..7bea0b14ab 100644 --- a/include/wx/collpane.h +++ b/include/wx/collpane.h @@ -26,15 +26,16 @@ class WXDLLEXPORT wxCollapsiblePaneBase : public wxControl public: wxCollapsiblePaneBase() {} - virtual void Expand() - { Collapse(false); } - virtual void Collapse(bool collapse = true) = 0; + void Expand() { Collapse(false); } + virtual bool IsCollapsed() const = 0; + bool IsExpanded() const { return !IsCollapsed(); } + virtual wxWindow *GetPane() const = 0; virtual wxString GetLabel() const = 0; - virtual void SetLabel(const wxString &label) = 0; + virtual void SetLabel(const wxString& label) = 0; }; diff --git a/src/generic/collpaneg.cpp b/src/generic/collpaneg.cpp index f8f7f3fcbc..b7e0dd6e9e 100644 --- a/src/generic/collpaneg.cpp +++ b/src/generic/collpaneg.cpp @@ -56,7 +56,8 @@ bool wxGenericCollapsiblePane::Create( wxWindow *parent, wxWindowID id, m_pButton = new wxButton(this, wxCP_BUTTON_ID, GetBtnLabel(), wxPoint(0, 0), wxDefaultSize, wxBU_EXACTFIT); m_pStatLine = new wxStaticLine(this, wxID_ANY); - m_pPane = new wxWindow(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxNO_BORDER); + m_pPane = new wxWindow(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, + wxNO_BORDER); // start as collapsed: m_pPane->Hide(); @@ -70,27 +71,27 @@ wxSize wxGenericCollapsiblePane::DoGetBestSize() const wxSize sz = m_pButton->GetBestSize(); // set width - sz.SetWidth( sz.GetWidth() + wxCP_MARGIN + m_pStatLine->GetBestSize().GetWidth() ); - sz.SetWidth( wxMax(sz.GetWidth(), m_pPane->GetBestSize().GetWidth()) ); + sz.SetWidth(sz.x + wxCP_MARGIN + m_pStatLine->GetBestSize().x); + const wxCoord paneWidth = m_pPane->GetBestSize().x; + if ( sz.x < paneWidth ) + sz.x = paneWidth; // when expanded, we need more vertical space - if (!IsCollapsed()) - sz.SetHeight( sz.GetHeight() + wxCP_MARGIN + m_pPane->GetBestSize().GetHeight() ); + if ( IsExpanded() ) + sz.SetHeight(sz.y + wxCP_MARGIN + m_pPane->GetBestSize().y); return sz; } wxString wxGenericCollapsiblePane::GetBtnLabel() const { - if (IsCollapsed()) - return m_strLabel + wxT(" >>"); - return m_strLabel + wxT(" <<"); + return m_strLabel + (IsCollapsed() ? wxT(" >>") : wxT(" <<")); } void wxGenericCollapsiblePane::Collapse(bool collapse) { // optimization - if (IsCollapsed() == collapse) + if ( IsCollapsed() == collapse ) return; // update our state @@ -108,28 +109,29 @@ void wxGenericCollapsiblePane::Collapse(bool collapse) wxWindow *top = GetTopLevelParent(); if (top) { - // we've changed our size, thus our top level parent needs to relayout itself + // we've changed our size, thus our top level parent needs to relayout + // itself top->Layout(); - // FIXME: this makes wxGenericCollapsiblePane behave as the user expect but - // maybe there are cases where this is unwanted! + // FIXME: this makes wxGenericCollapsiblePane behave as the user expect + // but maybe there are cases where this is unwanted! if (top->GetSizer()) #ifdef __WXGTK__ - // FIXME: the SetSizeHints() call would be required also for GTK+ for the - // expanded->collapsed transition. - // Unfortunately if we enable this line, then the GTK+ top window - // won't always be resized by the SetClientSize() call below! - // As a side effect of this dirty fix, the minimal size for the - // pane window is not set in GTK+ and the user can hide it shrinking - // the "top" window... + // FIXME: the SetSizeHints() call would be required also for GTK+ for + // the expanded->collapsed transition. Unfortunately if we + // enable this line, then the GTK+ top window won't always be + // resized by the SetClientSize() call below! As a side effect + // of this dirty fix, the minimal size for the pane window is + // not set in GTK+ and the user can hide it shrinking the "top" + // window... if (IsCollapsed()) #endif top->GetSizer()->SetSizeHints(top); if (IsCollapsed()) { - // NB: we need to use SetClientSize() and not SetSize() otherwise the size for - // windows like e.g. wxFrames with wxMenubars won't be correctly set + // use SetClientSize() and not SetSize() otherwise the size for + // e.g. a wxFrame with a menubar wouldn't be correctly set top->SetClientSize(sz); } else @@ -166,13 +168,13 @@ void wxGenericCollapsiblePane::LayoutChildren() // the button position & size are always ok... // move & resize the static line - m_pStatLine->SetSize(btnSz.GetWidth() + wxCP_MARGIN, btnSz.GetHeight()/2, - GetSize().GetWidth() - btnSz.GetWidth() - wxCP_MARGIN, -1, + m_pStatLine->SetSize(btnSz.x + wxCP_MARGIN, btnSz.y/2, + GetSize().x - btnSz.x - wxCP_MARGIN, -1, wxSIZE_USE_EXISTING); // move & resize the container window - m_pPane->SetSize(0, btnSz.GetHeight() + wxCP_MARGIN, - GetSize().GetWidth(), GetSize().GetHeight() - btnSz.GetHeight() - wxCP_MARGIN); + m_pPane->SetSize(0, btnSz.y + wxCP_MARGIN, + GetSize().x, GetSize().y - btnSz.y - wxCP_MARGIN); } diff --git a/src/gtk/collpane.cpp b/src/gtk/collpane.cpp index 263306affc..ced9096279 100644 --- a/src/gtk/collpane.cpp +++ b/src/gtk/collpane.cpp @@ -20,35 +20,16 @@ #ifdef __WXGTK24__ #include "wx/collpane.h" + #include #include +const wxChar wxCollapsiblePaneNameStr[] = wxT("CollapsiblePane"); + // ============================================================================ // implementation // ============================================================================ - -/* DEBUG TIMER */ -class myTimer : public wxTimer -{ - wxCollapsiblePane *p; - -public: - myTimer(wxCollapsiblePane *pp) {p=pp;} - - void Notify() - { - //wxLogDebug(wxT("%d"), p->IsCollapsed()); - - wxSize sz = p->GetBestSize(); - wxLogDebug(wxT("our best size is now: %d-%d"), sz.GetWidth(), sz.GetHeight()); - } -}; - - - -const wxChar wxCollapsiblePaneNameStr[] = wxT("CollapsiblePane"); - //----------------------------------------------------------------------------- // "notify::expanded" signal //----------------------------------------------------------------------------- @@ -59,40 +40,38 @@ static void gtk_collapsiblepane_expanded_callback (GObject *object, GParamSpec *param_spec, wxCollapsiblePane *p) { - // NB: unlike for the "activate" signal, when this callback is called, if we try to - // query the "collapsed" status through p->IsCollapsed(), we get the right value. - // I.e. here p->IsCollapsed() will return false if this callback has been called - // at the end of a collapsed->expanded transition and viceversa. - // Inside the "activate" signal callback p->IsCollapsed() would return the wrong value! - - wxLogDebug("gtk_collapsiblepane_expanded_callback - IsCollapsed says %d", p->IsCollapsed()); + // NB: unlike for the "activate" signal, when this callback is called, if + // we try to query the "collapsed" status through p->IsCollapsed(), we + // get the right value. I.e. here p->IsCollapsed() will return false if + // this callback has been called at the end of a collapsed->expanded + // transition and viceversa. Inside the "activate" signal callback + // p->IsCollapsed() would return the wrong value! wxSize sz; - if (!p->IsCollapsed()) + if ( p->IsExpanded() ) { - // unfortunately there's no clean way to retrieve the minimal size of the expanded pane - // in this handler or in other handlers for the signals generated by user clicks on the - // GtkExpander button: p->GetBestSize() or p->GetMinSize() would still return the size for - // the collapsed expander even if the collapsed->expanded transition has already been - // completed (this because GTK+ queues some resize calls which still must be processed). - // So, the only solution to correctly set the size hints for this window is to calculate - // the expanded size ourselves, without relying on p->Get[Best|Min]Size: + // unfortunately there's no clean way to retrieve the minimal size of + // the expanded pane in this handler or in other handlers for the + // signals generated by user clicks on the GtkExpander button: + // p->GetBestSize() or p->GetMinSize() would still return the size for + // the collapsed expander even if the collapsed->expanded transition + // has already been completed (this because GTK+ queues some resize + // calls which still must be processed). So, the only solution to + // correctly set the size hints for this window is to calculate the + // expanded size ourselves, without relying on p->Get[Best|Min]Size: sz = p->GetMinSize(); - sz.SetWidth( wxMax(sz.GetWidth(), p->GetPane()->GetMinSize().GetWidth()) ); - sz.SetHeight( sz.GetHeight() + p->GetPane()->GetMinSize().GetHeight() + 10 ); + sz.SetWidth(wxMax(sz.x, p->GetPane()->GetMinSize().x)); + sz.SetHeight(sz.y + p->GetPane()->GetMinSize().y + 10); } - else + else // collapsed { - // same problem described above: using p->Get[Best|Min]Size() here we would get the size - // of the control when it is expanded even if the expanded->collapsed transition should be - // complete now... + // same problem described above: using p->Get[Best|Min]Size() here we + // would get the size of the control when it is expanded even if the + // expanded->collapsed transition should be complete now... // So, we use the size cached at control-creation time... sz = p->m_szCollapsed; } - wxLogDebug(wxT("gtk_collapsiblepane_expanded_callback - my min size is now: %d-%d"), - sz.GetWidth(), sz.GetHeight()); - // minimal size has priority over the best size so set here our min size p->SetMinSize(sz); p->SetSize(sz); @@ -100,39 +79,28 @@ static void gtk_collapsiblepane_expanded_callback (GObject *object, wxWindow *top = p->GetTopLevelParent(); if (top) { - // we've changed our size, thus our top level parent needs to relayout itself + // we've changed our size, thus our top level parent needs to relayout + // itself top->Layout(); - // FIXME: this makes wxGenericCollapsiblePane behave as the user expect but - // maybe there are cases where this is unwanted! - if (top->GetSizer()) -#ifdef __WXGTK__ - // FIXME: the SetSizeHints() call would be required also for GTK+ for the - // expanded->collapsed transition. - // Unfortunately if we enable this line, then the GTK+ top window - // won't always be resized by the SetClientSize() call below! - // As a side effect of this dirty fix, the minimal size for the - // pane window is not set in GTK+ and the user can hide it shrinking - // the "top" window... - if (p->IsCollapsed()) -#endif - top->GetSizer()->SetSizeHints(top); - - if (p->IsCollapsed()) - { - // NB: we need to use SetClientSize() and not SetSize() otherwise the size for - // windows like e.g. wxFrames with wxMenubars won't be correctly set - top->SetClientSize(sz); - } - else + if (p->IsExpanded()) { // force our parent to "fit", i.e. expand so that it can honour // our minimal size top->Fit(); } + else // correctly + { + if (top->GetSizer()) + top->GetSizer()->SetSizeHints(top); + + // use SetClientSize() and not SetSize() otherwise the size for + // e.g. a wxFrame with a menubar wouldn't be correctly set + top->SetClientSize(sz); + } } - if (p->m_bIgnoreNextChange) + if ( p->m_bIgnoreNextChange ) { // change generated programmatically - do not send an event! p->m_bIgnoreNextChange = false; @@ -145,17 +113,17 @@ static void gtk_collapsiblepane_expanded_callback (GObject *object, } } -static void gtk_collapsiblepane_insert_callback( wxWindowGTK* parent, wxWindowGTK* child ) +static void +gtk_collapsiblepane_insert_callback(wxWindowGTK* parent, wxWindowGTK* child) { - // this callback should be used only once to insert the "pane" into - // the GtkExpander widget. wxGenericCollapsiblePane::DoAddChild() will check - // if it has been called only once (and in any case we would get a warning - // from the following call as GtkExpander is a GtkBin and can contain only a - // single child!). + // this callback should be used only once to insert the "pane" into the + // GtkExpander widget. wxGenericCollapsiblePane::DoAddChild() will check if + // it has been called only once (and in any case we would get a warning + // from the following call as GtkExpander is a GtkBin and can contain only + // a single child!). gtk_container_add (GTK_CONTAINER (parent->m_widget), child->m_widget); } - //----------------------------------------------------------------------------- // wxCollapsiblePane //----------------------------------------------------------------------------- @@ -166,23 +134,25 @@ BEGIN_EVENT_TABLE(wxCollapsiblePane, wxGenericCollapsiblePane) EVT_SIZE(wxCollapsiblePane::OnSize) END_EVENT_TABLE() -bool wxCollapsiblePane::Create( wxWindow *parent, wxWindowID id, - const wxString& label, - const wxPoint& pos, - const wxSize& size, - long style, - const wxValidator& val, - const wxString& name) +bool wxCollapsiblePane::Create(wxWindow *parent, + wxWindowID id, + const wxString& label, + const wxPoint& pos, + const wxSize& size, + long style, + const wxValidator& val, + const wxString& name) { - if (gtk_check_version(2,4,0)) {wxASSERT(0); - return wxGenericCollapsiblePane::Create(parent, id, label, pos, size, style, val, name);} + if (gtk_check_version(2,4,0)) + return wxGenericCollapsiblePane::Create(parent, id, label, + pos, size, style, val, name); m_needParent = true; m_acceptsFocus = true; m_bIgnoreNextChange = false; - if (!PreCreation( parent, pos, size ) || - !wxControl::CreateBase(parent, id, pos, size, style, val, name)) + if ( !PreCreation( parent, pos, size ) || + !wxControl::CreateBase(parent, id, pos, size, style, val, name) ) { wxFAIL_MSG( wxT("wxCollapsiblePane creation failed") ); return false; @@ -190,31 +160,28 @@ bool wxCollapsiblePane::Create( wxWindow *parent, wxWindowID id, m_widget = gtk_expander_new(label.c_str()); - // see the gtk_collapsiblepane_expanded_callback comments to understand why we connect - // to the "notify::expanded" signal instead of the more common "activate" one + // see the gtk_collapsiblepane_expanded_callback comments to understand why + // we connect to the "notify::expanded" signal instead of the more common + // "activate" one g_signal_connect(m_widget, "notify::expanded", G_CALLBACK(gtk_collapsiblepane_expanded_callback), this); - // before creating m_pPane, we need to makesure our own insert callback will be used + // before creating m_pPane, we need to makesure our own insert callback + // will be used m_insertCallback = gtk_collapsiblepane_insert_callback; // this the real "pane" - m_pPane = new wxWindow(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxNO_BORDER); + m_pPane = new wxWindow(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, + wxNO_BORDER); gtk_widget_show( GTK_WIDGET(m_widget) ); m_parent->DoAddChild( this ); PostCreation(size); - //SetBestSize(size); // remember the size of this control when it's collapsed m_szCollapsed = GetBestSize(); - /* - myTimer *t = new myTimer(this); - t->Start(2000); - */ - return true; } @@ -222,8 +189,6 @@ wxSize wxCollapsiblePane::DoGetBestSize() const { if (!gtk_check_version(2,4,0)) { - //return wxControl::DoGetBestSize(); // need not to cache the best size! - wxASSERT_MSG( m_widget, wxT("DoGetBestSize called before creation") ); GtkRequisition req; @@ -232,9 +197,8 @@ wxSize wxCollapsiblePane::DoGetBestSize() const (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request ) (m_widget, &req ); - wxSize best(req.width, req.height); - //CacheBestSize(best); - return best; + // notice that we do not cache our best size here as it changes + return wxSize(req.width, req.height); } return wxGenericCollapsiblePane::DoGetBestSize(); @@ -283,8 +247,6 @@ void wxCollapsiblePane::OnSize(wxSizeEvent &ev) dc.DrawRectangle(wxPoint(0,0), GetBestSize()); #endif - //wxLogDebug(wxT("wxCollapsiblePane::OnSize")); - // here we need to resize the pane window otherwise, even if the GtkExpander container // is expanded or shrinked, the pane window won't be updated! m_pPane->SetSize(ev.GetSize()); @@ -294,5 +256,5 @@ void wxCollapsiblePane::OnSize(wxSizeEvent &ev) m_pPane->Layout(); } -#endif // __WXGTK24__ +#endif // __WXGTK24__ -- 2.45.2