Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / popupwin.h

diff --git a/include/wx/popupwin.h b/include/wx/popupwin.h
index 6eb26bacb7426b17dae35dc80a5fe3439d0dce85..3a16fa1b1a82164b54a716322b021996128e235c 100644 (file)
--- a/include/wx/popupwin.h
+++ b/include/wx/popupwin.h
@@ -6,25 +6,24 @@
 // Created:     06.01.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     06.01.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// License:     wxWindows licence
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_POPUPWIN_H_BASE_
 #define _WX_POPUPWIN_H_BASE_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_POPUPWIN_H_BASE_
 #define _WX_POPUPWIN_H_BASE_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "popupwinbase.h"
-#endif
-
-#include "wx/window.h"
+#include "wx/defs.h"

 
 #if wxUSE_POPUPWIN
 
 #if wxUSE_POPUPWIN

+
+#include "wx/nonownedwnd.h"
+

 // ----------------------------------------------------------------------------
 // wxPopupWindow: a special kind of top level window used for popup menus,
 // combobox popups and such.
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxPopupWindow: a special kind of top level window used for popup menus,
 // combobox popups and such.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxPopupWindowBase : public wxWindow
+class WXDLLIMPEXP_CORE wxPopupWindowBase : public wxNonOwnedWindow

 {
 public:
     wxPopupWindowBase() { }
 {
 public:
     wxPopupWindowBase() { }


@@ -46,23 +45,29 @@ public:
     virtual void Position(const wxPoint& ptOrigin,
                           const wxSize& size);
 
     virtual void Position(const wxPoint& ptOrigin,
                           const wxSize& size);
 

-    DECLARE_NO_COPY_CLASS(wxPopupWindowBase)
+    virtual bool IsTopLevel() const { return true; }
+
+    wxDECLARE_NO_COPY_CLASS(wxPopupWindowBase);

 };
 
 
 // include the real class declaration
 };
 
 
 // include the real class declaration

-#ifdef __WXMSW__
+#if defined(__WXMSW__)

     #include "wx/msw/popupwin.h"
     #include "wx/msw/popupwin.h"

-#elif __WXPM__
+#elif defined(__WXPM__)

     #include "wx/os2/popupwin.h"
     #include "wx/os2/popupwin.h"

-#elif __WXGTK__
+#elif defined(__WXGTK20__)

     #include "wx/gtk/popupwin.h"
     #include "wx/gtk/popupwin.h"

-#elif __WXX11__
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/popupwin.h"
+#elif defined(__WXX11__)

     #include "wx/x11/popupwin.h"
     #include "wx/x11/popupwin.h"

-#elif __WXMOTIF__
+#elif defined(__WXMOTIF__)

     #include "wx/motif/popupwin.h"
     #include "wx/motif/popupwin.h"

-#elif __WXMGL__
-    #include "wx/mgl/popupwin.h"
+#elif defined(__WXDFB__)
+    #include "wx/dfb/popupwin.h"
+#elif defined(__WXMAC__)
+    #include "wx/osx/popupwin.h"

 #else
     #error "wxPopupWindow is not supported under this platform."
 #endif
 #else
     #error "wxPopupWindow is not supported under this platform."
 #endif


@@ -72,10 +77,10 @@ public:
 // when the user clicks mouse outside it or if it loses focus in any other way
 // ----------------------------------------------------------------------------
 
 // when the user clicks mouse outside it or if it loses focus in any other way
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxPopupWindowHandler;
-class WXDLLEXPORT wxPopupFocusHandler;
+class WXDLLIMPEXP_FWD_CORE wxPopupWindowHandler;
+class WXDLLIMPEXP_FWD_CORE wxPopupFocusHandler;

 
 

-class WXDLLEXPORT wxPopupTransientWindow : public wxPopupWindow
+class WXDLLIMPEXP_CORE wxPopupTransientWindow : public wxPopupWindow

 {
 public:
     // ctors
 {
 public:
     // ctors


@@ -95,13 +100,19 @@ public:
     //
     // VZ: where is this used??
     virtual bool CanDismiss()
     //
     // VZ: where is this used??
     virtual bool CanDismiss()

-        { return TRUE; }
+        { return true; }

 
 

-    // called when a mouse is pressed while the popup is shown: return TRUE
+    // called when a mouse is pressed while the popup is shown: return true

     // from here to prevent its normal processing by the popup (which consists
     // from here to prevent its normal processing by the popup (which consists

-    // in dismissing it if the mouse is cilcked outside it)
+    // in dismissing it if the mouse is clicked outside it)

     virtual bool ProcessLeftDown(wxMouseEvent& event);
 
     virtual bool ProcessLeftDown(wxMouseEvent& event);
 

+    // Overridden to grab the input on some plaforms
+    virtual bool Show( bool show = true );
+
+    // Override to implement delayed destruction of this window.
+    virtual bool Destroy();
+

 protected:
     // common part of all ctors
     void Init();
 protected:
     // common part of all ctors
     void Init();


@@ -116,6 +127,15 @@ protected:
     // remove our event handlers
     void PopHandlers();
 
     // remove our event handlers
     void PopHandlers();
 

+    // get alerted when child gets deleted from under us
+    void OnDestroy(wxWindowDestroyEvent& event);
+
+#if defined(__WXMSW__) ||(defined(__WXMAC__) && wxOSX_USE_COCOA_OR_CARBON)
+    // Check if the mouse needs to be captured or released: we must release
+    // when it's inside our window if we want the embedded controls to work.
+    void OnIdle(wxIdleEvent& event);
+#endif
+

     // the child of this popup if any
     wxWindow *m_child;
 
     // the child of this popup if any
     wxWindow *m_child;
 


@@ -130,8 +150,9 @@ protected:
     wxPopupWindowHandler *m_handlerPopup;
     wxPopupFocusHandler  *m_handlerFocus;
 
     wxPopupWindowHandler *m_handlerPopup;
     wxPopupFocusHandler  *m_handlerFocus;
 

+    DECLARE_EVENT_TABLE()

     DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow)
     DECLARE_DYNAMIC_CLASS(wxPopupTransientWindow)

-    DECLARE_NO_COPY_CLASS(wxPopupTransientWindow)
+    wxDECLARE_NO_COPY_CLASS(wxPopupTransientWindow);

 };
 
 #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
 };
 
 #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)


@@ -140,16 +161,16 @@ protected:
 // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
 // ----------------------------------------------------------------------------
 
 // wxPopupComboWindow: wxPopupTransientWindow used by wxComboBox
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxComboBox;
-class WXDLLEXPORT wxComboControl;
+class WXDLLIMPEXP_FWD_CORE wxComboBox;
+class WXDLLIMPEXP_FWD_CORE wxComboCtrl;

 
 

-class WXDLLEXPORT wxPopupComboWindow : public wxPopupTransientWindow
+class WXDLLIMPEXP_CORE wxPopupComboWindow : public wxPopupTransientWindow

 {
 public:
     wxPopupComboWindow() { m_combo = NULL; }
 {
 public:
     wxPopupComboWindow() { m_combo = NULL; }

-    wxPopupComboWindow(wxComboControl *parent);
+    wxPopupComboWindow(wxComboCtrl *parent);

 
 

-    bool Create(wxComboControl *parent);
+    bool Create(wxComboCtrl *parent);

 
     // position the window correctly relatively to the combo
     void PositionNearCombo();
 
     // position the window correctly relatively to the combo
     void PositionNearCombo();


@@ -162,7 +183,7 @@ protected:
     void OnKeyDown(wxKeyEvent& event);
 
     // the parent combobox
     void OnKeyDown(wxKeyEvent& event);
 
     // the parent combobox

-    wxComboControl *m_combo;
+    wxComboCtrl *m_combo;

 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxPopupComboWindow)
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxPopupComboWindow)


@@ -173,4 +194,3 @@ protected:
 #endif // wxUSE_POPUPWIN
 
 #endif // _WX_POPUPWIN_H_BASE_
 #endif // wxUSE_POPUPWIN
 
 #endif // _WX_POPUPWIN_H_BASE_

-