Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h
index 51aa45c6569f0f54e79ebcf4238609d25f245424..27775eb513c9809363a603ab89c2ae3ac8deae43 100644 (file)
--- a/interface/wx/toplevel.h
+++ b/interface/wx/toplevel.h
@@ -2,8 +2,7 @@
 // Name:        toplevel.h
 // Purpose:     interface of wxTopLevelWindow
 // Author:      wxWidgets team
 // Name:        toplevel.h
 // Purpose:     interface of wxTopLevelWindow
 // Author:      wxWidgets team

-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -34,6 +33,14 @@ enum
                           wxFULLSCREEN_NOCAPTION
 };
 
                           wxFULLSCREEN_NOCAPTION
 };
 

+#define wxDEFAULT_FRAME_STYLE (wxSYSTEM_MENU |          \
+                               wxRESIZE_BORDER |        \
+                               wxMINIMIZE_BOX |         \
+                               wxMAXIMIZE_BOX |         \
+                               wxCLOSE_BOX |            \
+                               wxCAPTION |              \
+                               wxCLIP_CHILDREN)
+

 /**
     @class wxTopLevelWindow
 
 /**
     @class wxTopLevelWindow
 


@@ -45,14 +52,68 @@ enum
     Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
     internal top level window list.
 
     Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
     internal top level window list.
 

+    @beginEventEmissionTable
+    @event{EVT_MAXIMIZE(id, func)}
+        Process a @c wxEVT_MAXIMIZE event. See wxMaximizeEvent.
+    @event{EVT_MOVE(func)}
+        Process a @c wxEVT_MOVE event, which is generated when a window is moved.
+        See wxMoveEvent.
+    @event{EVT_MOVE_START(func)}
+        Process a @c wxEVT_MOVE_START event, which is generated when the user starts
+        to move or size a window. wxMSW only.
+        See wxMoveEvent.
+    @event{EVT_MOVE_END(func)}
+        Process a @c wxEVT_MOVE_END event, which is generated when the user stops
+        moving or sizing a window. wxMSW only.
+        See wxMoveEvent.
+    @event{EVT_SHOW(func)}
+        Process a @c wxEVT_SHOW event. See wxShowEvent.
+    @endEventTable
+

     @library{wxcore}
     @category{managedwnd}
 
     @see wxDialog, wxFrame
 */
     @library{wxcore}
     @category{managedwnd}
 
     @see wxDialog, wxFrame
 */

-class wxTopLevelWindow : public wxWindow
+class wxTopLevelWindow : public wxNonOwnedWindow

 {
 public:
 {
 public:

+    /**
+        Default ctor.
+    */
+    wxTopLevelWindow();
+
+    /**
+        Constructor creating the top level window.
+    */
+    wxTopLevelWindow(wxWindow *parent,
+                    wxWindowID id,
+                    const wxString& title,
+                    const wxPoint& pos = wxDefaultPosition,
+                    const wxSize& size = wxDefaultSize,
+                    long style = wxDEFAULT_FRAME_STYLE,
+                    const wxString& name = wxFrameNameStr);
+
+    /**
+        Destructor. Remember that wxTopLevelWindows do not get immediately
+        destroyed when the user (or the app) closes them; they have a
+        @b delayed destruction.
+
+        See @ref overview_windowdeletion for more info.
+    */
+    virtual ~wxTopLevelWindow();
+
+    /**
+        Creates the top level window.
+    */
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr);
+

     /**
         Returns @true if the platform supports making the window translucent.
 
     /**
         Returns @true if the platform supports making the window translucent.
 


@@ -63,7 +124,7 @@ public:
     /**
         A synonym for CentreOnScreen().
     */
     /**
         A synonym for CentreOnScreen().
     */

-    void CenterOnScreen(int direction);
+    void CenterOnScreen(int direction = wxBOTH);

 
     /**
         Centres the window on screen.
 
     /**
         Centres the window on screen.


@@ -96,6 +157,19 @@ public:
     */
     wxWindow* GetDefaultItem() const;
 
     */
     wxWindow* GetDefaultItem() const;
 

+    /**
+        Get the default size for a new top level window.
+
+        This is used internally by wxWidgets on some platforms to determine the
+        default size for a window created using ::wxDefaultSize so it is not
+        necessary to use it when creating a wxTopLevelWindow, however it may be
+        useful if a rough estimation of the window size is needed for some
+        other reason.
+
+        @since 2.9.2
+     */
+    static wxSize GetDefaultSize();
+

     /**
         Returns the standard icon of the window. The icon will be invalid if it
         hadn't been previously set by SetIcon().
     /**
         Returns the standard icon of the window. The icon will be invalid if it
         hadn't been previously set by SetIcon().


@@ -139,7 +213,7 @@ public:
     virtual void Iconize(bool iconize = true);
 
     /**
     virtual void Iconize(bool iconize = true);
 
     /**

-        Returns @true if this window is currently active, i.e. if the user is
+        Returns @true if this window is currently active, i.e.\ if the user is

         currently working with it.
     */
     virtual bool IsActive();
         currently working with it.
     */
     virtual bool IsActive();


@@ -195,6 +269,33 @@ public:
     */
     virtual void Maximize(bool maximize = true);
 
     */
     virtual void Maximize(bool maximize = true);
 

+    /**
+        MSW-specific function for accessing the system menu.
+
+        Returns a wxMenu pointer representing the system menu of the window
+        under MSW. The returned wxMenu may be used, if non-@c NULL, to add
+        extra items to the system menu. The usual @c wxEVT_MENU
+        events (that can be processed using @c EVT_MENU event table macro) will
+        then be generated for them. All the other wxMenu methods may be used as
+        well but notice that they won't allow you to access any standard system
+        menu items (e.g. they can't be deleted or modified in any way
+        currently).
+
+        Notice that because of the native system limitations the identifiers of
+        the items added to the system menu must be multiples of 16, otherwise
+        no events will be generated for them.
+
+        The returned pointer must @em not be deleted, it is owned by the window
+        and will be only deleted when the window itself is destroyed.
+
+        This function is not available in the other ports by design, any
+        occurrences of it in the portable code must be guarded by
+        @code #ifdef __WXMSW__ @endcode preprocessor guards.
+
+        @since 2.9.3
+     */
+    wxMenu *MSWGetSystemMenu() const;
+

     /**
         Use a system-dependent way to attract users attention to the window when
         it is in background.
     /**
         Use a system-dependent way to attract users attention to the window when
         it is in background.


@@ -221,6 +322,11 @@ public:
     */
     wxWindow* SetDefaultItem(wxWindow* win);
 
     */
     wxWindow* SetDefaultItem(wxWindow* win);
 

+    
+    wxWindow*  SetTmpDefaultItem(wxWindow * win);
+    wxWindow* GetTmpDefaultItem() const;
+
+    

     /**
         Sets the icon for this window.
 
     /**
         Sets the icon for this window.
 


@@ -299,15 +405,6 @@ public:
                       const wxString& label = wxEmptyString,
                       wxMenu* subMenu = NULL);
 
                       const wxString& label = wxEmptyString,
                       wxMenu* subMenu = NULL);
 

-    /**
-        If the platform supports it, sets the shape of the window to that
-        depicted by @a region. The system will not display or respond to any
-        mouse event for the pixels that lie outside of the region. To reset the
-        window to the normal rectangular shape simply call SetShape() again with
-        an empty wxRegion. Returns @true if the operation is successful.
-    */
-    virtual bool SetShape(const wxRegion& region);
-

     /**
         Allows specification of minimum and maximum window sizes, and window
         size increments. If a pair of values is not set (or set to -1), no
     /**
         Allows specification of minimum and maximum window sizes, and window
         size increments. If a pair of values is not set (or set to -1), no


@@ -373,7 +470,7 @@ public:
 
         @param alpha
             Determines how opaque or transparent the window will be, if the
 
         @param alpha
             Determines how opaque or transparent the window will be, if the

-            platform supports the opreration. A value of 0 sets the window to be
+            platform supports the operation. A value of 0 sets the window to be

             fully transparent, and a value of 255 sets the window to be fully
             opaque.
     */
             fully transparent, and a value of 255 sets the window to be fully
             opaque.
     */


@@ -387,7 +484,45 @@ public:
         there are any open top level windows.
     */
     virtual bool ShouldPreventAppExit() const;
         there are any open top level windows.
     */
     virtual bool ShouldPreventAppExit() const;

+    
+    /**
+        This function sets the wxTopLevelWindow's modified state on OS X,
+        which currently draws a black dot in the wxTopLevelWindow's close button.
+        On other platforms, this method does nothing.
+        
+        @see OSXIsModified()
+    */
+    virtual void OSXSetModified(bool modified);
+    
+    /**
+        Returns the current modified state of the wxTopLevelWindow on OS X.
+        On other platforms, this method does nothing.
+        
+        @see OSXSetModified()
+    */
+    virtual bool OSXIsModified() const;
+
+    /**
+        Sets the file name represented by this wxTopLevelWindow.
+
+        Under OS X, this file name is used to set the "proxy icon", which
+        appears in the window title bar near its title, corresponding to this
+        file name. Under other platforms it currently doesn't do anything but
+        it is harmless to call it now and it might be implemented to do
+        something useful in the future so you're encouraged to use it for any
+        window representing a file-based document.

 
 

+        @since 2.9.4
+    */
+    virtual void SetRepresentedFilename(const wxString& filename);
+
+    /**
+        Show the wxTopLevelWindow, but do not give it keyboard focus. This can be
+        used for pop up or notification windows that should not steal the current
+        focus.
+     */
+    virtual void ShowWithoutActivating();
+    

     /**
         Depending on the value of @a show parameter the window is either shown
         full screen or restored to its normal state. @a style is a bit list
     /**
         Depending on the value of @a show parameter the window is either shown
         full screen or restored to its normal state. @a style is a bit list