Fix stc doxygen warnings and regen stc files.

[wxWidgets.git] / src / gtk / collpane.cpp

diff --git a/src/gtk/collpane.cpp b/src/gtk/collpane.cpp
index 24f0215b2d4fb35b56febd851081d857cccc9a68..ac2b928d807e1ce4b1859a4e6ee11532f0d38065 100644 (file)
--- a/src/gtk/collpane.cpp
+++ b/src/gtk/collpane.cpp
@@ -4,7 +4,6 @@
 // Author:      Francesco Montorsi
 // Modified By:
 // Created:     8/10/2006
 // Author:      Francesco Montorsi
 // Modified By:
 // Created:     8/10/2006

-// Id:          $Id$

 // Copyright:   (c) Francesco Montorsi
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Francesco Montorsi
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -17,14 +16,25 @@
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 

-#ifdef __WXGTK24__
+#if wxUSE_COLLPANE && !defined(__WXUNIVERSAL__)

 
 #include "wx/collpane.h"
 
 #include "wx/collpane.h"

+#include "wx/toplevel.h"
+#include "wx/sizer.h"
+#include "wx/panel.h"

 
 

-#include <gtk/gtkexpander.h>

 #include <gtk/gtk.h>
 #include <gtk/gtk.h>

+#include "wx/gtk/private.h"
+#include "wx/gtk/private/gtk2-compat.h"

 
 

-const wxChar wxCollapsiblePaneNameStr[] = wxT("CollapsiblePane");
+// the lines below duplicate the same definitions in collpaneg.cpp, if we have
+// another implementation of this class we should extract them to a common file
+
+const char wxCollapsiblePaneNameStr[] = "collapsiblePane";
+
+wxDEFINE_EVENT( wxEVT_COLLAPSIBLEPANE_CHANGED, wxCollapsiblePaneEvent );
+
+IMPLEMENT_DYNAMIC_CLASS(wxCollapsiblePaneEvent, wxCommandEvent)

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -36,9 +46,10 @@ const wxChar wxCollapsiblePaneNameStr[] = wxT("CollapsiblePane");
 
 extern "C" {
 
 
 extern "C" {
 

-static void gtk_collapsiblepane_expanded_callback (GObject    *object,
-                                                    GParamSpec *param_spec,
-                                                    wxCollapsiblePane *p)
+static void
+gtk_collapsiblepane_expanded_callback(GObject * WXUNUSED(object),
+                                      GParamSpec * WXUNUSED(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
 {
     // NB: unlike for the "activate" signal, when this callback is called, if
     //     we try to query the "collapsed" status through p->IsCollapsed(), we


@@ -50,18 +61,16 @@ static void gtk_collapsiblepane_expanded_callback (GObject    *object,
     wxSize sz;
     if ( p->IsExpanded() )
     {
     wxSize sz;
     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:
-        sz = p->GetMinSize();
-        sz.SetWidth(wxMax(sz.x, p->GetPane()->GetMinSize().x));
-        sz.SetHeight(sz.y + p->GetPane()->GetMinSize().y + 10);
+        // NB: we cannot use the p->GetBestSize() or p->GetMinSize() functions
+        //     here as they would return the size for the collapsed expander
+        //     even if the collapsed->expanded transition has already been
+        //     completed; we solve this problem doing:
+
+        sz = p->m_szCollapsed;
+
+        wxSize panesz = p->GetPane()->GetBestSize();
+        sz.x = wxMax(sz.x, panesz.x);
+        sz.y += gtk_expander_get_spacing(GTK_EXPANDER(p->m_widget)) + panesz.y;

     }
     else // collapsed
     {
     }
     else // collapsed
     {


@@ -72,30 +81,57 @@ static void gtk_collapsiblepane_expanded_callback (GObject    *object,
         sz = p->m_szCollapsed;
     }
 
         sz = p->m_szCollapsed;
     }
 

-    // minimal size has priority over the best size so set here our min size
+    // VERY IMPORTANT:
+    // just calling
+    //          p->OnStateChange(sz);
+    // here would work work BUT:
+    //     1) in the expanded->collapsed transition it provokes a lot of flickering
+    //     2) in the collapsed->expanded transition using the "Change status" wxButton
+    //        in samples/collpane application some strange warnings would be generated
+    //        by the "clearlooks" theme, if that's your theme.
+    //
+    // So we prefer to use some GTK+ native optimized calls, which prevent too many resize
+    // calculations to happen. Note that the following code has been very carefully designed
+    // and tested - be VERY careful when changing it!
+
+    // 1) need to update our size hints
+    // NB: this function call won't actually do any long operation
+    //     (redraw/relayout/resize) so that it's flicker-free

     p->SetMinSize(sz);
     p->SetMinSize(sz);

-    p->SetSize(sz);

 
 

-    wxWindow *top = p->GetTopLevelParent();
-    if (top)
+    if (p->HasFlag(wxCP_NO_TLW_RESIZE))

     {
     {

-        // we've changed our size, thus our top level parent needs to relayout
-        // itself
-        top->Layout();
+        // fire an event
+        wxCollapsiblePaneEvent ev(p, p->GetId(), p->IsCollapsed());
+        p->HandleWindowEvent(ev);

 
 

-        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);
+        // the user asked to explicitly handle the resizing itself...
+        return;
+    }
+
+    wxTopLevelWindow *
+        top = wxDynamicCast(wxGetTopLevelParent(p), wxTopLevelWindow);
+    if ( top && top->GetSizer() )
+    {
+        // 2) recalculate minimal size of the top window
+        sz = top->GetSizer()->CalcMin();

 
 

-            // use SetClientSize() and not SetSize() otherwise the size for
-            // e.g. a wxFrame with a menubar wouldn't be correctly set
+        if (top->m_mainWidget)
+        {
+            // 3) MAGIC HACK: if you ever used GtkExpander in a GTK+ program
+            //    you know that this magic call is required to make it possible
+            //    to shrink the top level window in the expanded->collapsed
+            //    transition.  This may be sometimes undesired but *is*
+            //    necessary and if you look carefully, all GTK+ programs using
+            //    GtkExpander perform this trick (e.g. the standard "open file"
+            //    dialog of GTK+>=2.4 is not resizable when the expander is
+            //    collapsed!)
+            gtk_window_set_resizable (GTK_WINDOW (top->m_widget), p->IsExpanded());
+
+            // 4) set size hints
+            top->SetMinClientSize(sz);
+
+            // 5) set size

             top->SetClientSize(sz);
         }
     }
             top->SetClientSize(sz);
         }
     }


@@ -109,28 +145,27 @@ static void gtk_collapsiblepane_expanded_callback (GObject    *object,
 
     // fire an event
     wxCollapsiblePaneEvent ev(p, p->GetId(), p->IsCollapsed());
 
     // fire an event
     wxCollapsiblePaneEvent ev(p, p->GetId(), p->IsCollapsed());

-    p->GetEventHandler()->ProcessEvent(ev);
+    p->HandleWindowEvent(ev);

 }
 }
 
 }
 }
 

-static void
-gtk_collapsiblepane_insert_callback(wxWindowGTK* parent, wxWindowGTK* child)
+void wxCollapsiblePane::AddChildGTK(wxWindowGTK* child)

 {
 {

-    // this callback should be used only once to insert the "pane" into the
+    // 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!).
     // 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);
+    gtk_container_add(GTK_CONTAINER(m_widget), child->m_widget);

 }
 
 //-----------------------------------------------------------------------------
 // wxCollapsiblePane
 //-----------------------------------------------------------------------------
 
 }
 
 //-----------------------------------------------------------------------------
 // wxCollapsiblePane
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxCollapsiblePane, wxGenericCollapsiblePane)
+IMPLEMENT_DYNAMIC_CLASS(wxCollapsiblePane, wxControl)

 
 

-BEGIN_EVENT_TABLE(wxCollapsiblePane, wxGenericCollapsiblePane)
+BEGIN_EVENT_TABLE(wxCollapsiblePane, wxCollapsiblePaneBase)

     EVT_SIZE(wxCollapsiblePane::OnSize)
 END_EVENT_TABLE()
 
     EVT_SIZE(wxCollapsiblePane::OnSize)
 END_EVENT_TABLE()
 


@@ -143,12 +178,6 @@ bool wxCollapsiblePane::Create(wxWindow *parent,
                                const wxValidator& val,
                                const wxString& name)
 {
                                const wxValidator& val,
                                const wxString& 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 ) ||
     m_bIgnoreNextChange = false;
 
     if ( !PreCreation( parent, pos, size ) ||


@@ -160,6 +189,7 @@ bool wxCollapsiblePane::Create(wxWindow *parent,
 
     m_widget =
         gtk_expander_new_with_mnemonic(wxGTK_CONV(GTKConvertMnemonics(label)));
 
     m_widget =
         gtk_expander_new_with_mnemonic(wxGTK_CONV(GTKConvertMnemonics(label)));

+    g_object_ref(m_widget);

 
     // see the gtk_collapsiblepane_expanded_callback comments to understand why
     // we connect to the "notify::expanded" signal instead of the more common
 
     // see the gtk_collapsiblepane_expanded_callback comments to understand why
     // we connect to the "notify::expanded" signal instead of the more common


@@ -167,19 +197,19 @@ bool wxCollapsiblePane::Create(wxWindow *parent,
     g_signal_connect(m_widget, "notify::expanded",
                      G_CALLBACK(gtk_collapsiblepane_expanded_callback), this);
 
     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
-    m_insertCallback = gtk_collapsiblepane_insert_callback;
-

     // this the real "pane"
     // this the real "pane"

-    m_pPane = new wxWindow(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
-                           wxNO_BORDER);
+    m_pPane = new wxPanel(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
+                          wxTAB_TRAVERSAL|wxNO_BORDER, wxS("wxCollapsiblePanePane"));

 
 

-    gtk_widget_show( GTK_WIDGET(m_widget) );

     m_parent->DoAddChild( this );
 
     PostCreation(size);
 
     m_parent->DoAddChild( this );
 
     PostCreation(size);
 

+    // we should blend into our parent background
+    const wxColour bg = parent->GetBackgroundColour();
+    SetBackgroundColour(bg);
+    m_pPane->SetBackgroundColour(bg);
+

     // remember the size of this control when it's collapsed
     m_szCollapsed = GetBestSize();
 
     // remember the size of this control when it's collapsed
     m_szCollapsed = GetBestSize();
 


@@ -188,53 +218,44 @@ bool wxCollapsiblePane::Create(wxWindow *parent,
 
 wxSize wxCollapsiblePane::DoGetBestSize() const
 {
 
 wxSize wxCollapsiblePane::DoGetBestSize() const
 {

-    if (!gtk_check_version(2,4,0))
-    {
-        wxASSERT_MSG( m_widget, wxT("DoGetBestSize called before creation") );
-
-        GtkRequisition req;
-        req.width = 2;
-        req.height = 2;
-        (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
-                (m_widget, &req );
+    wxASSERT_MSG( m_widget, wxT("DoGetBestSize called before creation") );

 
 

-        // notice that we do not cache our best size here as it changes
-        return wxSize(req.width, req.height);
-    }
+    GtkRequisition req;
+#ifdef __WXGTK3__
+    gtk_widget_get_preferred_size(m_widget, NULL, &req);
+#else
+    GTK_WIDGET_GET_CLASS(m_widget)->size_request(m_widget, &req);
+#endif

 
 

-    return wxGenericCollapsiblePane::DoGetBestSize();
+    // notice that we do not cache our best size here as it changes
+    // all times the user expands/hide our pane
+    return wxSize(req.width, req.height);

 }
 
 void wxCollapsiblePane::Collapse(bool collapse)
 {
 }
 
 void wxCollapsiblePane::Collapse(bool collapse)
 {

-    if (!gtk_check_version(2,4,0))
-    {
-        // optimization
-        if (IsCollapsed() == collapse)
-            return;
+    // optimization
+    if (IsCollapsed() == collapse)
+        return;

 
 

-        // do not send event in next signal handler call
-        m_bIgnoreNextChange = true;
-        gtk_expander_set_expanded(GTK_EXPANDER(m_widget), !collapse);
-    }
-    else
-        wxGenericCollapsiblePane::Collapse(collapse);
+    // do not send event in next signal handler call
+    m_bIgnoreNextChange = true;
+    gtk_expander_set_expanded(GTK_EXPANDER(m_widget), !collapse);

 }
 
 bool wxCollapsiblePane::IsCollapsed() const
 {
 }
 
 bool wxCollapsiblePane::IsCollapsed() const
 {

-    if (!gtk_check_version(2,4,0))
-        return !gtk_expander_get_expanded(GTK_EXPANDER(m_widget));
-
-    return wxGenericCollapsiblePane::IsCollapsed();
+    return !gtk_expander_get_expanded(GTK_EXPANDER(m_widget));

 }
 
 void wxCollapsiblePane::SetLabel(const wxString &str)
 {
 }
 
 void wxCollapsiblePane::SetLabel(const wxString &str)
 {

-    if (!gtk_check_version(2,4,0))
-        gtk_expander_set_label(GTK_EXPANDER(m_widget), str.c_str());
-    else
-        wxGenericCollapsiblePane::SetLabel(str);
+    gtk_expander_set_label(GTK_EXPANDER(m_widget),
+                           wxGTK_CONV(GTKConvertMnemonics(str)));
+
+    // FIXME: we need to update our collapsed width in some way but using GetBestSize()
+    // we may get the size of the control with the pane size summed up if we are expanded!
+    //m_szCollapsed.x = GetBestSize().x;

 }
 
 void wxCollapsiblePane::OnSize(wxSizeEvent &ev)
 }
 
 void wxCollapsiblePane::OnSize(wxSizeEvent &ev)


@@ -249,13 +270,23 @@ void wxCollapsiblePane::OnSize(wxSizeEvent &ev)
 #endif
 
     // here we need to resize the pane window otherwise, even if the GtkExpander container
 #endif
 
     // 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());
+    // is expanded or shrunk, the pane window won't be updated!
+    m_pPane->SetSize(ev.GetSize().x, ev.GetSize().y - m_szCollapsed.y);

 
 

-    // we need to explicitely call m_pPane->Layout() or else it won't correctly relayout
+    // we need to explicitly call m_pPane->Layout() or else it won't correctly relayout

     // (even if SetAutoLayout(true) has been called on it!)
     m_pPane->Layout();
 }
 
     // (even if SetAutoLayout(true) has been called on it!)
     m_pPane->Layout();
 }
 

-#endif //  __WXGTK24__
+
+GdkWindow *wxCollapsiblePane::GTKGetWindow(wxArrayGdkWindows& windows) const
+{
+    GtkWidget *label = gtk_expander_get_label_widget( GTK_EXPANDER(m_widget) );
+    windows.Add(gtk_widget_get_window(label));
+    windows.Add(gtk_widget_get_window(m_widget));
+
+    return NULL;
+}
+
+#endif // wxUSE_COLLPANE && !defined(__WXUNIVERSAL__)