Add wxPopupWindow

[wxWidgets.git] / interface / toplevel.h

diff --git a/interface/toplevel.h b/interface/toplevel.h
index ac138306a82b851588a1a2aafb5fb547dedb9b4d..b036c7837e465fcacb5fe8a2cc75595600b75b0f 100644 (file)
--- a/interface/toplevel.h
+++ b/interface/toplevel.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        toplevel.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        toplevel.h

-// Purpose:     documentation for wxTopLevelWindow class
+// Purpose:     interface of wxTopLevelWindow

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,25 +9,24 @@
 /**
     @class wxTopLevelWindow
     @wxheader{toplevel.h}
 /**
     @class wxTopLevelWindow
     @wxheader{toplevel.h}

-    
+

     wxTopLevelWindow is a common base class for wxDialog and
     wxFrame. It is an abstract base class meaning that you never
     work with objects of this class directly, but all of its methods are also
     applicable for the two classes above.
     wxTopLevelWindow is a common base class for wxDialog and
     wxFrame. It is an abstract base class meaning that you never
     work with objects of this class directly, but all of its methods are also
     applicable for the two classes above.

-    
+

     @library{wxcore}
     @category{managedwnd}
     @library{wxcore}
     @category{managedwnd}

-    
-    @seealso
-    wxTopLevelWindow::SetTransparent
+
+    @see wxTopLevelWindow::SetTransparent

 */
 class wxTopLevelWindow : public wxWindow
 {
 public:
     /**
         Returns @true if the platform supports making the window translucent.
 */
 class wxTopLevelWindow : public wxWindow
 {
 public:
     /**
         Returns @true if the platform supports making the window translucent.

-        
-        @sa SetTransparent()
+
+        @see SetTransparent()

     */
     virtual bool CanSetTransparent();
 
     */
     virtual bool CanSetTransparent();
 


@@ -38,12 +37,12 @@ public:
 
     /**
         Centres the window on screen.
 
     /**
         Centres the window on screen.

-        
-        @param direction 
-        Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL
-        or wxBOTH.
-        
-        @sa wxWindow::CentreOnParent
+
+        @param direction
+            Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL
+            or wxBOTH.
+
+        @see wxWindow::CentreOnParent

     */
     void CentreOnScreen(int direction = wxBOTH);
 
     */
     void CentreOnScreen(int direction = wxBOTH);
 


@@ -56,41 +55,40 @@ public:
         X11 (including GTK+) where the window manager may not support
         this operation and there is no way to find out.
     */
         X11 (including GTK+) where the window manager may not support
         this operation and there is no way to find out.
     */

-    bool EnableCloseButton(bool enable = @true);
+    bool EnableCloseButton(bool enable = true);

 
     /**
         Returns a pointer to the button which is the default for this window, or @c
         @NULL.
         The default button is the one activated by pressing the Enter key.
     */
 
     /**
         Returns a pointer to the button which is the default for this window, or @c
         @NULL.
         The default button is the one activated by pressing the Enter key.
     */

-    wxWindow * GetDefaultItem();
+    wxWindow* GetDefaultItem() const;

 
     /**
         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().

-        
-        @sa GetIcons()
+
+        @see GetIcons()

     */
     */

-    const wxIcon GetIcon();
+    const wxIcon GetIcon() const;

 
     /**
         Returns all icons associated with the window, there will be none of them if
         neither SetIcon() nor
         SetIcons() had been called before.
 
     /**
         Returns all icons associated with the window, there will be none of them if
         neither SetIcon() nor
         SetIcons() had been called before.

-        

         Use GetIcon() to get the main icon of the
         window.
         Use GetIcon() to get the main icon of the
         window.

-        
-        @sa wxIconBundle
+
+        @see wxIconBundle

     */
     */

-    const wxIconBundle GetIcons();
+    const wxIconBundle GetIcons() const;

 
     /**
         Gets a string containing the window title.
 
     /**
         Gets a string containing the window title.

-        
-        @sa SetTitle()
+
+        @see SetTitle()

     */
     */

-    wxString GetTitle();
+    wxString GetTitle() const;

 
     /**
         Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input panel)
 
     /**
         Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input panel)


@@ -103,11 +101,11 @@ public:
 
     /**
         Iconizes or restores the window.
 
     /**
         Iconizes or restores the window.

-        
-        @param iconize 
-        If @true, iconizes the window; if @false, shows and restores it.
-        
-        @sa IsIconized(), Maximize().
+
+        @param iconize
+            If @true, iconizes the window; if @false, shows and restores it.
+
+        @see IsIconized(), Maximize().

     */
     void Iconize(bool iconize);
 
     */
     void Iconize(bool iconize);
 


@@ -116,85 +114,81 @@ public:
         currently
         working with it.
     */
         currently
         working with it.
     */

-    bool IsActive();
+    bool IsActive() const;

 
     /**
         Returns @true if this window is expected to be always maximized, either due
         to platform policy
         or due to local policy regarding particular class.
     */
 
     /**
         Returns @true if this window is expected to be always maximized, either due
         to platform policy
         or due to local policy regarding particular class.
     */

-    virtual bool IsAlwaysMaximized();
+    virtual bool IsAlwaysMaximized() const;

 
     /**
         Returns @true if the window is in fullscreen mode.
 
     /**
         Returns @true if the window is in fullscreen mode.

-        
-        @sa ShowFullScreen()
+
+        @see ShowFullScreen()

     */
     bool IsFullScreen();
 
     /**
         Returns @true if the window is iconized.
     */
     */
     bool IsFullScreen();
 
     /**
         Returns @true if the window is iconized.
     */

-    bool IsIconized();
+    bool IsIconized() const;

 
     /**
         Returns @true if the window is maximized.
     */
 
     /**
         Returns @true if the window is maximized.
     */

-    bool IsMaximized();
+    bool IsMaximized() const;

 
     /**
         @b @c This method is specific to wxUniversal port
 
     /**
         @b @c This method is specific to wxUniversal port

-        

         Returns @true if this window is using native decorations, @false if we draw
         them ourselves.
         Returns @true if this window is using native decorations, @false if we draw
         them ourselves.

-        
-        @sa UseNativeDecorations(),
-              UseNativeDecorationsByDefault()
+
+        @see UseNativeDecorations(),
+             UseNativeDecorationsByDefault()

     */
     */

-    bool IsUsingNativeDecorations();
+    bool IsUsingNativeDecorations() const;

 
     /**
         Maximizes or restores the window.
 
     /**
         Maximizes or restores the window.

-        
-        @param maximize 
-        If @true, maximizes the window, otherwise it restores it.
-        
-        @sa Iconize()
+
+        @param maximize
+            If @true, maximizes the window, otherwise it restores it.
+
+        @see Iconize()

     */
     void Maximize(bool maximize);
 
     /**
         Use a system-dependent way to attract users attention to the window when it is
         in background.
     */
     void Maximize(bool maximize);
 
     /**
         Use a system-dependent way to attract users attention to the window when it is
         in background.

-        
-        @e flags may have the value of either @c wxUSER_ATTENTION_INFO
+        @a flags may have the value of either @c wxUSER_ATTENTION_INFO

         (default) or @c wxUSER_ATTENTION_ERROR which results in a more drastic
         action. When in doubt, use the default value.
         (default) or @c wxUSER_ATTENTION_ERROR which results in a more drastic
         action. When in doubt, use the default value.

-        

         Note that this function should normally be only used when the application is
         not already in foreground.
         Note that this function should normally be only used when the application is
         not already in foreground.

-        

         This function is currently implemented for Win32 where it flashes the
         window icon in the taskbar, and for wxGTK with task bars supporting it.
     */
     void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 
     /**
         This function is currently implemented for Win32 where it flashes the
         window icon in the taskbar, and for wxGTK with task bars supporting it.
     */
     void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 
     /**

-        Changes the default item for the panel, usually @e win is a button.
-        
-        @sa GetDefaultItem()
+        Changes the default item for the panel, usually @a win is a button.
+
+        @see GetDefaultItem()

     */
     void SetDefaultItem(wxWindow win);
 
     /**
         Sets the icon for this window.
     */
     void SetDefaultItem(wxWindow win);
 
     /**
         Sets the icon for this window.

-        
-        @param icon 
-        The icon to associate with this window.
-        
+
+        @param icon
+            The icon to associate with this window.
+

         @remarks The window takes a 'copy' of icon, but since it uses reference
         @remarks The window takes a 'copy' of icon, but since it uses reference

-                   counting, the copy is very quick. It is safe to
-                   delete icon after calling this function.
+                 counting, the copy is very quick. It is safe to delete
+                 icon after calling this function.

     */
     void SetIcon(const wxIcon& icon);
 
     */
     void SetIcon(const wxIcon& icon);
 


@@ -203,11 +197,11 @@ public:
         different icons for different situations (e.g. task switching bar, taskbar,
         window title bar) instead of scaling, with possibly bad looking results, the
         only icon set by SetIcon().
         different icons for different situations (e.g. task switching bar, taskbar,
         window title bar) instead of scaling, with possibly bad looking results, the
         only icon set by SetIcon().

-        
-        @param icons 
-        The icons to associate with this window.
-        
-        @sa wxIconBundle.
+
+        @param icons
+            The icons to associate with this window.
+
+        @see wxIconBundle.

     */
     void SetIcons(const wxIconBundle& icons);
 
     */
     void SetIcons(const wxIconBundle& icons);
 


@@ -215,21 +209,19 @@ public:
         Sets action or menu activated by pressing left hardware button on the smart
         phones.
         Unavailable on full keyboard machines.
         Sets action or menu activated by pressing left hardware button on the smart
         phones.
         Unavailable on full keyboard machines.

-        
-        @param id 
-        Identifier for this button.
-        
-        @param label 
-        Text to be displayed on the screen area dedicated to this hardware button.
-        
-        @param subMenu 
-        The menu to be opened after pressing this hardware button.
-        
-        @sa SetRightMenu().
+
+        @param id
+            Identifier for this button.
+        @param label
+            Text to be displayed on the screen area dedicated to this hardware button.
+        @param subMenu
+            The menu to be opened after pressing this hardware button.
+
+        @see SetRightMenu().

     */
     void SetLeftMenu(int id = wxID_ANY,
                      const wxString& label = wxEmptyString,
     */
     void SetLeftMenu(int id = wxID_ANY,
                      const wxString& label = wxEmptyString,

-                     wxMenu * subMenu = @NULL);
+                     wxMenu* subMenu = NULL);

 
     /**
         A simpler interface for setting the size hints than
 
     /**
         A simpler interface for setting the size hints than


@@ -247,21 +239,19 @@ public:
         Sets action or menu activated by pressing right hardware button on the smart
         phones.
         Unavailable on full keyboard machines.
         Sets action or menu activated by pressing right hardware button on the smart
         phones.
         Unavailable on full keyboard machines.

-        
-        @param id 
-        Identifier for this button.
-        
-        @param label 
-        Text to be displayed on the screen area dedicated to this hardware button.
-        
-        @param subMenu 
-        The menu to be opened after pressing this hardware button.
-        
-        @sa SetLeftMenu().
+
+        @param id
+            Identifier for this button.
+        @param label
+            Text to be displayed on the screen area dedicated to this hardware button.
+        @param subMenu
+            The menu to be opened after pressing this hardware button.
+
+        @see SetLeftMenu().

     */
     void SetRightMenu(int id = wxID_ANY,
                       const wxString& label = wxEmptyString,
     */
     void SetRightMenu(int id = wxID_ANY,
                       const wxString& label = wxEmptyString,

-                      wxMenu * subMenu = @NULL);
+                      wxMenu* subMenu = NULL);

 
     /**
         If the platform supports it, sets the shape of the window to that
 
     /**
         If the platform supports it, sets the shape of the window to that


@@ -278,49 +268,47 @@ public:
         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 constraints will be used.
         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 constraints will be used.

-        
-        @param incW 
-        Specifies the increment for sizing the width (GTK/Motif/Xt only).
-        
-        @param incH 
-        Specifies the increment for sizing the height (GTK/Motif/Xt only).
-        
-        @param incSize 
-        Increment size (only taken into account under X11-based
-        ports such as wxGTK/wxMotif/wxX11).
-        
+
+        @param incW
+            Specifies the increment for sizing the width (GTK/Motif/Xt only).
+        @param incH
+            Specifies the increment for sizing the height (GTK/Motif/Xt only).
+        @param incSize
+            Increment size (only taken into account under X11-based
+            ports such as wxGTK/wxMotif/wxX11).
+

         @remarks Notice that this function not only prevents the user from
         @remarks Notice that this function not only prevents the user from

-                   resizing the window outside the given bounds but it
-                   also prevents the program itself from doing it using
-                   SetSize.
-    */
-    virtual void SetSizeHints(int minW, int minH, int maxW=-1,
-                              int maxH=-1,
-                              int incW=-1,
-                              int incH=-1);
-        void SetSizeHints(const wxSize& minSize,
-                          const wxSize& maxSize=wxDefaultSize,
-                          const wxSize& incSize=wxDefaultSize);
+                 resizing the window outside the given bounds but it
+                 also prevents the program itself from doing it using
+                 SetSize.
+    */
+    virtual void SetSizeHints(int minW, int minH, int maxW = -1,
+                              int maxH = -1,
+                              int incW = -1,
+                              int incH = -1);
+    void SetSizeHints(const wxSize& minSize,
+                      const wxSize& maxSize = wxDefaultSize,
+                      const wxSize& incSize = wxDefaultSize);

     //@}
 
     /**
         Sets the window title.
     //@}
 
     /**
         Sets the window title.

-        
-        @param title 
-        The window title.
-        
-        @sa GetTitle()
+
+        @param title
+            The window title.
+
+        @see GetTitle()

     */
     virtual void SetTitle(const wxString& title);
 
     /**
         If the platform supports it will set the window to be translucent
     */
     virtual void SetTitle(const wxString& title);
 
     /**
         If the platform supports it will set the window to be translucent

-        
-        @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 fully transparent, and a value of 255 sets the window
-          to be fully opaque.
+
+        @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 fully transparent, and a value of 255 sets the window
+              to be fully opaque.

     */
     virtual bool SetTransparent(int alpha);
 
     */
     virtual bool SetTransparent(int alpha);
 


@@ -331,55 +319,50 @@ public:
         By default, the application stays alive as long as there are any open top level
         windows.
     */
         By default, the application stays alive as long as there are any open top level
         windows.
     */

-    virtual bool ShouldPreventAppExit();
+    virtual bool ShouldPreventAppExit() const;

 
     /**
 
     /**

-        Depending on the value of @e show parameter the window is either shown full
-        screen or restored to its normal state. @e style is a bit list containing
+        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 containing

         some or all of the following values, which indicate what elements of the window
         to hide in full-screen mode:
         some or all of the following values, which indicate what elements of the window
         to hide in full-screen mode:

-        

          wxFULLSCREEN_NOMENUBAR
          wxFULLSCREEN_NOTOOLBAR
          wxFULLSCREEN_NOSTATUSBAR
          wxFULLSCREEN_NOBORDER
          wxFULLSCREEN_NOCAPTION
          wxFULLSCREEN_ALL (all of the above)
          wxFULLSCREEN_NOMENUBAR
          wxFULLSCREEN_NOTOOLBAR
          wxFULLSCREEN_NOSTATUSBAR
          wxFULLSCREEN_NOBORDER
          wxFULLSCREEN_NOCAPTION
          wxFULLSCREEN_ALL (all of the above)

-        

         This function has not been tested with MDI frames.
         This function has not been tested with MDI frames.

-        

         Note that showing a window full screen also actually
         @ref wxWindow::show Show()s if it hadn't been shown yet.
         Note that showing a window full screen also actually
         @ref wxWindow::show Show()s if it hadn't been shown yet.

-        
-        @sa IsFullScreen()
+
+        @see IsFullScreen()

     */
     bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
 
     /**
         @b @c This method is specific to wxUniversal port
     */
     bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
 
     /**
         @b @c This method is specific to wxUniversal port

-        

         Use native or custom-drawn decorations for this window only. Notice that to
         have any effect this method must be called before really creating the window,
         i.e. two step creation must be used:
         Use native or custom-drawn decorations for this window only. Notice that to
         have any effect this method must be called before really creating the window,
         i.e. two step creation must be used:

-        
-        @sa UseNativeDecorationsByDefault(),
-              IsUsingNativeDecorations()
+
+        @see UseNativeDecorationsByDefault(),
+             IsUsingNativeDecorations()

     */
     */

-    void UseNativeDecorations(bool native = @true);
+    void UseNativeDecorations(bool native = true);

 
     /**
         @b @c This method is specific to wxUniversal port
 
     /**
         @b @c This method is specific to wxUniversal port

-        

         Top level windows in wxUniversal port can use either system-provided window
         decorations (i.e. title bar and various icons, buttons and menus in it) or draw
         the decorations themselves. By default the system decorations are used if they
         Top level windows in wxUniversal port can use either system-provided window
         decorations (i.e. title bar and various icons, buttons and menus in it) or draw
         the decorations themselves. By default the system decorations are used if they

-        are available, but this method can be called with @e native set to @false to
+        are available, but this method can be called with @a native set to @false to

         change this for all windows created after this point.
         change this for all windows created after this point.

-        

         Also note that if @c WXDECOR environment variable is set, then custom
         decorations are used by default and so it may make sense to call this method
         with default argument if the application can't use custom decorations at all
         for some reason.
     */
         Also note that if @c WXDECOR environment variable is set, then custom
         decorations are used by default and so it may make sense to call this method
         with default argument if the application can't use custom decorations at all
         for some reason.
     */

-    void UseNativeDecorationsByDefault(bool native = @true);
+    void UseNativeDecorationsByDefault(bool native = true);

 };
 };

+