Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/collpane.h

@@ -0,0 +1,176 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        collpane.h
+// Purpose:     interface of wxCollapsiblePane
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxCollapsiblePaneEvent
+    @wxheader{collpane.h}
+
+    This event class is used for the events generated by wxCollapsiblePane.
+
+    @beginEventTable{wxCollapsiblePaneEvent}
+    @event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)}
+           The user expanded or collapsed the collapsible pane.
+    @endEventTable
+
+    @library{wxcore}
+    @category{events}
+
+    @see wxCollapsiblePane
+*/
+class wxCollapsiblePaneEvent : public wxCommandEvent
+{
+public:
+    /**
+        The constructor is not normally used by the user code.
+    */
+    wxCollapsiblePaneEvent(wxObject* generator, int id, bool collapsed);
+
+    /**
+        Returns @true if the pane has been collapsed.
+    */
+    bool GetCollapsed() const;
+
+    /**
+        Sets this as a collapsed pane event (if @a collapsed is @true) or as an
+        expanded pane event (if @a collapsed is @false).
+    */
+    void SetCollapsed(bool collapsed);
+};
+
+
+
+/**
+    @class wxCollapsiblePane
+    @wxheader{collpane.h}
+
+    A collapsible pane is a container with an embedded button-like control
+    which can be used by the user to collapse or expand the pane's contents.
+
+    Once constructed you should use the GetPane() function to access the pane
+    and add your controls inside it (i.e. use the returned pointer from
+    GetPane() as parent for the controls which must go in the pane, @b not the
+    wxCollapsiblePane itself!).
+
+    Note that because of its nature of control which can dynamically (and
+    drastically) change its size at run-time under user-input, when putting
+    wxCollapsiblePane inside a wxSizer you should be careful to add it with a
+    proportion value of zero; this is because otherwise all other windows with
+    non-null proportion values will automatically resize each time the user
+    expands or collapse the pane window usually resulting in a weird,
+    flickering effect.
+
+    Usage sample:
+
+    @code
+    wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, wxT("Details:"));
+
+    // add the pane with a zero proportion value to the 'sz' sizer which contains it
+    sz->Add(collpane, 0, wxGROW|wxALL, 5);
+
+    // now add a test label in the collapsible pane using a sizer to layout it:
+    wxWindow *win = collpane->GetPane();
+    wxSizer *paneSz = new wxBoxSizer(wxVERTICAL);
+    paneSz->Add(new wxStaticText(win, wxID_ANY, wxT("test!")), 1, wxGROW|wxALL, 2);
+    win->SetSizer(paneSz);
+    paneSz->SetSizeHints(win);
+    @endcode
+
+    It is only available if @c wxUSE_COLLPANE is set to 1 (the default).
+
+    @beginStyleTable
+    @style{wxCP_DEFAULT_STYLE}
+           The default style: 0.
+    @endStyleTable
+
+    @beginEventTable{wxCollapsiblePaneEvent}
+    @event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)}
+           The user expanded or collapsed the collapsible pane.
+    @endEventTable
+
+    @library{wxcore}
+    @category{ctrl}
+    <!-- @appearance{collapsiblepane.png} -->
+
+    @see wxPanel, wxCollapsiblePaneEvent
+*/
+class wxCollapsiblePane : public wxControl
+{
+public:
+    /**
+        Default constructor.
+    */
+    wxCollapsiblePane();
+    
+    /**
+        Initializes the object and calls Create() with all the parameters.
+    */
+    wxCollapsiblePane(wxWindow* parent, wxWindowID id,
+                      const wxString& label,
+                      const wxPoint& pos = wxDefaultPosition,
+                      const wxSize& size = wxDefaultSize,
+                      long style = wxCP_DEFAULT_STYLE,
+                      const wxValidator& validator = wxDefaultValidator,
+                      const wxString& name = "collapsiblePane");
+
+    /**
+        @param parent
+            Parent window, must not be non-@NULL.
+        @param id
+            The identifier for the control.
+        @param label
+            The initial label shown in the button which allows the user to
+            expand or collapse the pane window.
+        @param pos
+            Initial position.
+        @param size
+            Initial size.
+        @param style
+            The window style, see wxCP_* flags.
+        @param validator
+            Validator which can be used for additional date checks.
+        @param name
+            Control name.
+
+        @return @true if the control was successfully created or @false if
+                creation failed.
+    */
+    bool Create(wxWindow* parent, wxWindowID id,
+                const wxString& label,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxCP_DEFAULT_STYLE,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = "collapsiblePane");
+
+    /**
+        Collapses or expands the pane window.
+    */
+    void Collapse(bool collapse = true);
+
+    /**
+        Same as calling Collapse(@false).
+    */
+    void Expand();
+
+    /**
+        Returns a pointer to the pane window. Add controls to the returned
+        wxWindow to make them collapsible.
+    */
+    wxWindow* GetPane() const;
+
+    /**
+        Returns @true if the pane window is currently hidden.
+    */
+    bool IsCollapsed() const;
+
+    /**
+        Returns @true if the pane window is currently shown.
+    */
+    bool IsExpanded() const;
+};
+