]> git.saurik.com Git - wxWidgets.git/blobdiff - contrib/include/wx/fl/cbcustom.h
implement wxColourDialog::Move() (patch 548048)
[wxWidgets.git] / contrib / include / wx / fl / cbcustom.h
index ff0c3446cec6ab324703544cbf1a6590ee27377f..0445a23f62ea1c423802288193b6b9e562987e6f 100644 (file)
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        No names yet.
-// Purpose:     Contrib. demo
+// Name:        cbcustom.h
+// Purpose:     cbSimpleCustomizationPlugin class declaration
 // Author:      Aleksandras Gluchovas
 // Modified by:
 // Created:     28/10/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Aleksandras Gluchovas
 // Author:      Aleksandras Gluchovas
 // Modified by:
 // Created:     28/10/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Aleksandras Gluchovas
-// Licence:    wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __CBCUSTOM_G__
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __CBCUSTOM_G__
 
 #include "wx/fl/controlbar.h"
 
 
 #include "wx/fl/controlbar.h"
 
+/*
+This class enables customization of a bar, popping up a
+menu and handling basic customization such as floating
+and horizontal/vertical alignment of the bar.
+*/
+
 class cbSimpleCustomizationPlugin : public cbPluginBase
 {
 public:
 class cbSimpleCustomizationPlugin : public cbPluginBase
 {
 public:
-       DECLARE_DYNAMIC_CLASS( cbSimpleCustomizationPlugin )
+    DECLARE_DYNAMIC_CLASS( cbSimpleCustomizationPlugin )
 
 
-       int mCustMenuItemId;
+    int mCustMenuItemId;
 public:
 
 public:
 
-       cbSimpleCustomizationPlugin(void);
-
-       cbSimpleCustomizationPlugin( wxFrameLayout* pPanel, int paneMask = wxALL_PANES );
-
-       // plugin-event handlers
+        // Default constructor.
+    cbSimpleCustomizationPlugin(void);
 
 
-       void OnCustomizeBar( cbCustomizeBarEvent& event );
+        // Constructor, taking parent pane and a pane mask flag.
+    cbSimpleCustomizationPlugin( wxFrameLayout* pPanel, int paneMask = wxALL_PANES );
 
 
-       void OnCustomizeLayout( cbCustomizeLayoutEvent& event );
+        // Plugin event handler for cbCustomizeBarEvent.
+    void OnCustomizeBar( cbCustomizeBarEvent& event );
 
 
-       // menu-event handler
+        // Plugin event handler for cbCustomizeLayoutEvent.
+    void OnCustomizeLayout( cbCustomizeLayoutEvent& event );
 
 
-       void OnMenuItemSelected( wxCommandEvent& event );
+        // Menu event handler.
+    void OnMenuItemSelected( wxCommandEvent& event );
 
 
-       DECLARE_EVENT_TABLE()
+    DECLARE_EVENT_TABLE()
 };
 
 #endif /* __CBCUSTOM_G__ */
 };
 
 #endif /* __CBCUSTOM_G__ */