Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / generic / infobar.h

diff --git a/include/wx/generic/infobar.h b/include/wx/generic/infobar.h
index 16cf5d4ab08657b752733fd3e06832dae4bc4ebd..7beb08ad0477092256ad666e53232e7c5f0a1ea6 100644 (file)
--- a/include/wx/generic/infobar.h
+++ b/include/wx/generic/infobar.h
@@ -3,7 +3,7 @@
 // Purpose:     generic wxInfoBar class declaration
 // Author:      Vadim Zeitlin
 // Created:     2009-07-28
 // Purpose:     generic wxInfoBar class declaration
 // Author:      Vadim Zeitlin
 // Created:     2009-07-28

-// RCS-ID:      $Id: wxhead.h,v 1.11 2009-06-29 10:23:04 zeitlin Exp $
+// RCS-ID:      $Id$

 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////


@@ -19,7 +19,7 @@ class WXDLLIMPEXP_FWD_CORE wxStaticText;
 // wxInfoBar
 // ----------------------------------------------------------------------------
 
 // wxInfoBar
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_ADV wxInfoBarGeneric : public wxInfoBarBase
+class WXDLLIMPEXP_CORE wxInfoBarGeneric : public wxInfoBarBase

 {
 public:
     // the usual ctors and Create() but remember that info bar is created
 {
 public:
     // the usual ctors and Create() but remember that info bar is created


@@ -63,8 +63,8 @@ public:
     }
 
     // get effect used when showing/hiding the window
     }
 
     // get effect used when showing/hiding the window

-    wxShowEffect GetShowEffect() const { return m_showEffect; }
-    wxShowEffect GetHideEffect() const { return m_hideEffect; }
+    wxShowEffect GetShowEffect() const;
+    wxShowEffect GetHideEffect() const;

 
     // set the duration of animation used when showing/hiding the bar, in ms
     void SetEffectDuration(int duration) { m_effectDuration = duration; }
 
     // set the duration of animation used when showing/hiding the bar, in ms
     void SetEffectDuration(int duration) { m_effectDuration = duration; }


@@ -101,13 +101,26 @@ private:
     void DoShow();
     void DoHide();
 
     void DoShow();
     void DoHide();
 

+    // determine the placement of the bar from its position in the containing
+    // sizer
+    enum BarPlacement
+    {
+        BarPlacement_Top,
+        BarPlacement_Bottom,
+        BarPlacement_Unknown
+    };
+
+    BarPlacement GetBarPlacement() const;
+

 
     // different controls making up the bar
     wxStaticBitmap *m_icon;
     wxStaticText *m_text;
     wxBitmapButton *m_button;
 
 
     // different controls making up the bar
     wxStaticBitmap *m_icon;
     wxStaticText *m_text;
     wxBitmapButton *m_button;
 

-    // the effects to use when showing/hiding and duration for them
+    // the effects to use when showing/hiding and duration for them: by default
+    // the effect is determined by the info bar automatically depending on its
+    // position and the default duration is used

     wxShowEffect m_showEffect,
                  m_hideEffect;
     int m_effectDuration;
     wxShowEffect m_showEffect,
                  m_hideEffect;
     int m_effectDuration;