X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8e08b761b0c5ecb6df295785b78f1f3637331887..9838b284443a889c6c629568011c8ce76cfbacd4:/contrib/include/wx/fl/barhintspl.h

diff --git a/contrib/include/wx/fl/barhintspl.h b/contrib/include/wx/fl/barhintspl.h
index 809b101d91..e672740248 100644
--- a/contrib/include/wx/fl/barhintspl.h
+++ b/contrib/include/wx/fl/barhintspl.h
@@ -1,18 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        No names yet.
-// Purpose:     Contrib. demo
+// Name:        barhintspl.h
+// Purpose:     cbBarHintsPlugin class declaration
 // Author:      Aleksandras Gluchovas
 // Modified by:
 // Created:     30/11/98 (my 22th birthday :-)
 // RCS-ID:      $Id$
 // Copyright:   (c) Aleksandras Gluchovas
-// Licence:   	wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __DRAGHINTSPL_G__
 #define __DRAGHINTSPL_G__
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
     #pragma interface "barhintspl.h"
 #endif
 
@@ -20,76 +20,95 @@
 #include "wx/fl/toolwnd.h"
 
 /*
- * Intercepts bar-decoration and sizing events, draws 3d-hints
- * around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x
- */
+This class intercepts bar-decoration and sizing events, and draws 3D hints
+around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x
+*/
 
-class cbBarHintsPlugin : public cbPluginBase
+class WXDLLIMPEXP_FL cbBarHintsPlugin : public cbPluginBase
 {
-	DECLARE_DYNAMIC_CLASS( cbBarHintsPlugin )
+    DECLARE_DYNAMIC_CLASS( cbBarHintsPlugin )
 
 protected:
-	cbDockPane* mpPane; // is set up temorarely, while handling event
+    cbDockPane* mpPane; // is set up temorarely, while handling event
 
-	cbMiniButton* mBoxes[2];
+    cbMiniButton* mBoxes[2];
 
-	bool        mBtnPressed;
-	bool        mClosePressed;
-	cbBarInfo*  mpClickedBar;
-	bool        mDepressed;
+    bool        mBtnPressed;
+    bool        mClosePressed;
+    cbBarInfo*  mpClickedBar;
+    bool        mDepressed;
 
 protected:
-	// drawing helpers
+        // Helper function: draws a 3D box.
+    void Draw3DBox      ( wxDC& dc, const wxPoint& pos, bool pressed );
 
-	void Draw3DBox      ( wxDC& dc, const wxPoint& pos, bool pressed );
-	void DrawCloseBox   ( wxDC& dc, const wxPoint& pos, bool pressed );
-	void DrawCollapseBox( wxDC& dc, const wxPoint& pos, 
-						  bool atLeft, bool disabled, bool pressed );
+        // Helper function: draws a close box.
+    void DrawCloseBox   ( wxDC& dc, const wxPoint& pos, bool pressed );
 
-	void DrawGrooves    ( wxDC& dc, const wxPoint& pos, int length );
+        // Helper function: draws a collapse box.
+    void DrawCollapseBox( wxDC& dc, const wxPoint& pos,
+                          bool atLeft, bool disabled, bool pressed );
 
-	void DoDrawHint( wxDC& dc, wxRect& rect, int pos, int boxOfs, int grooveOfs, bool isFixed );
-	
-	void GetHintsLayout( wxRect& rect, cbBarInfo& info, 
-						 int& boxOfs, int& grooveOfs, int& pos );
+        // Helper function: draws grooves.
+    void DrawGrooves    ( wxDC& dc, const wxPoint& pos, int length );
 
-	int HitTestHints( cbBarInfo& info, const wxPoint& pos );
+        // Helper function: draws a hint.
+    void DoDrawHint( wxDC& dc, wxRect& rect, int pos, int boxOfs, int grooveOfs, bool isFixed );
 
-	void ExcludeHints( wxRect& rect, cbBarInfo& info );
+        // Helper function: gets the layout of a hint.
+    void GetHintsLayout( wxRect& rect, cbBarInfo& info,
+                         int& boxOfs, int& grooveOfs, int& pos );
 
-	void CreateBoxes();
+        // Helper function: returns information about the hint under the given position.
+    int HitTestHints( cbBarInfo& info, const wxPoint& pos );
 
-public:
-	/* public properties */
+        // Helper function.
+    void ExcludeHints( wxRect& rect, cbBarInfo& info );
 
-	bool mCloseBoxOn;    // default: ON
-	bool mCollapseBoxOn; // default: ON
-	int  mGrooveCount;   // default: 2 (two shaded bars)
-	int  mHintGap;       // default: 5 (pixels from above, below, right and left)
-	int  mXWeight;       // default: 2 (width in pixels of lines which used for drawing cross)
+        // Helper function: creates close and collapse boxes.
+    void CreateBoxes();
 
 public:
+    /* public properties */
+
+    bool mCloseBoxOn;    // default: ON
+    bool mCollapseBoxOn; // default: ON
+    int  mGrooveCount;   // default: 2 (two shaded bars)
+    int  mHintGap;       // default: 5 (pixels from above, below, right and left)
+    int  mXWeight;       // default: 2 (width in pixels of lines which used for drawing cross)
 
-	cbBarHintsPlugin(void);
+public:
+        // Default constructor.
+    cbBarHintsPlugin(void);
 
-	cbBarHintsPlugin( wxFrameLayout* pLayout, int paneMask = wxALL_PANES );
+        // Constructor, taking parent frame and pane mask flag.
+    cbBarHintsPlugin( wxFrameLayout* pLayout, int paneMask = wxALL_PANES );
 
+        // Destructor.
     ~cbBarHintsPlugin();
 
-	void SetGrooveCount( int nGrooves );
+        // Set the number of grooves to be shown in the pane.
+    void SetGrooveCount( int nGrooves );
+
+        // Called to initialize this plugin.
+    void OnInitPlugin();
+
+        // Handles a plugin event.
+    void OnSizeBarWindow( cbSizeBarWndEvent& event );
 
-	void OnInitPlugin();
+        // Handles a plugin event.
+    void OnDrawBarDecorations( cbDrawBarDecorEvent& event );
 
-	// handlers of plugin-events
+        // Handles a plugin event.
+    void OnLeftDown( cbLeftDownEvent& event );
 
-	void OnSizeBarWindow( cbSizeBarWndEvent& event );
-	void OnDrawBarDecorations( cbDrawBarDecorEvent& event );
+        // Handles a plugin event.
+    void OnLeftUp  ( cbLeftUpEvent&   event );
 
-	void OnLeftDown( cbLeftDownEvent& event );
-	void OnLeftUp  ( cbLeftUpEvent&   event );
-	void OnMotion  ( cbMotionEvent&   event );
+        // Handles a plugin event.
+    void OnMotion  ( cbMotionEvent&   event );
 
-	DECLARE_EVENT_TABLE()
+    DECLARE_EVENT_TABLE()
 };
 
 #endif /* __DRAGHINTSPL_G__ */