support for iPhone callbacks

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

diff --git a/interface/wx/popupwin.h b/interface/wx/popupwin.h
index 9ffd2c106cccc91f38c1ae98c22fdd4ddb78d215..4c1476d1712b1ad42c030e6cbb68e99c47a4417c 100644 (file)
--- a/interface/wx/popupwin.h
+++ b/interface/wx/popupwin.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        popupwin.h
-// Purpose:     interface of wxPoppWindow
+// Purpose:     interface of wxPopupWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows licence
@@ -22,6 +22,11 @@ class wxPopupWindow: public wxNonOwnedWindow
 {
 public:
 
+    /**
+      Default constructor
+    */
+    wxPopupWindow();
+    
     /**
       Constructor
     */
@@ -33,7 +38,7 @@ public:
     bool Create(wxWindow *parent, int flags = wxBORDER_NONE);
 
     /**
-        Move the popup window to the right position, i.e. such that it is
+        Move the popup window to the right position, i.e.\ such that it is
         entirely visible.
 
         The popup is positioned at ptOrigin + size if it opens below and to the
@@ -49,3 +54,64 @@ public:
                           const wxSize& sizePopup);
 };
 
+/**
+    @class wxPopupTransientWindow
+
+    A wxPopupWindow which disappears automatically when the user clicks mouse
+    outside it or if it loses focus in any other way.
+
+    This window can be useful for implementing custom combobox-like controls
+    for example.
+
+    @library{wxcore}
+    @category{managedwnd}
+
+    @see wxPopupWindow
+*/
+
+class wxPopupTransientWindow : public wxPopupWindow
+{
+public:
+    /**
+        Default constructor.
+    */
+    wxPopupTransientWindow();
+
+    /**
+        Constructor.
+    */
+    wxPopupTransientWindow(wxWindow *parent, int flags = wxBORDER_NONE);
+
+    /**
+        Popup the window (this will show it too).
+
+        If @a winFocus is non-@NULL, it will be kept focused while this window
+        is shown, otherwise this window itself will receive focus. In any case,
+        the popup will disappear automatically if it loses focus because of a
+        user action.
+
+        @see Dismiss()
+    */
+    virtual void Popup(wxWindow *focus = NULL);
+
+    /**
+        Hide the window.
+    */
+    virtual void Dismiss();
+
+    /**
+        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 in dismissing it if the mouse is clicked outside it).
+    */
+    virtual bool ProcessLeftDown(wxMouseEvent& event);
+
+protected:
+    /**
+       This is called when the popup is disappeared because of anything
+       else but direct call to Dismiss().
+    */
+    virtual void OnDismiss();
+    
+};