First attempt to document raw bitmap access

[wxWidgets.git] / interface / mdi.h

diff --git a/interface/mdi.h b/interface/mdi.h
index 67002953874c7fc7b812e4aaba24b9c3f4649aaa..3d5f3b80bc95cc280f115f71f2b03dcab8b576a1 100644 (file)
--- a/interface/mdi.h
+++ b/interface/mdi.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        mdi.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        mdi.h

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

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


@@ -16,8 +16,7 @@
     @library{wxcore}
     @category{FIXME}
 
     @library{wxcore}
     @category{FIXME}
 

-    @seealso
-    wxMDIChildFrame, wxMDIParentFrame, wxFrame
+    @see wxMDIChildFrame, wxMDIParentFrame, wxFrame

 */
 class wxMDIClientWindow : public wxWindow
 {
 */
 class wxMDIClientWindow : public wxWindow
 {


@@ -25,15 +24,15 @@ public:
     //@{
     /**
         Constructor, creating the window.
     //@{
     /**
         Constructor, creating the window.

-        
+

         @param parent
             The window parent.
         @param style
             The window style. Currently unused.
         @param parent
             The window parent.
         @param style
             The window style. Currently unused.

-        
+

         @remarks The second style of constructor is called within
                  wxMDIParentFrame::OnCreateClient.
         @remarks The second style of constructor is called within
                  wxMDIParentFrame::OnCreateClient.

-        
+

         @see wxMDIParentFrame::wxMDIParentFrame, wxMDIParentFrame::OnCreateClient
     */
     wxMDIClientWindow();
         @see wxMDIParentFrame::wxMDIParentFrame, wxMDIParentFrame::OnCreateClient
     */
     wxMDIClientWindow();


@@ -53,6 +52,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxMDIParentFrame
     @wxheader{mdi.h}
 /**
     @class wxMDIParentFrame
     @wxheader{mdi.h}


@@ -63,37 +63,37 @@ public:
     and is used in many popular Windows applications, such as Microsoft Word(TM).
 
     @beginStyleTable
     and is used in many popular Windows applications, such as Microsoft Word(TM).
 
     @beginStyleTable

-    @style{wxCAPTION}:
+    @style{wxCAPTION}

            Puts a caption on the frame.
            Puts a caption on the frame.

-    @style{wxDEFAULT_FRAME_STYLE}:
+    @style{wxDEFAULT_FRAME_STYLE}

            Defined as wxMINIMIZE_BOX |  wxMAXIMIZE_BOX |  wxTHICK_FRAME |
            wxSYSTEM_MENU |  wxCAPTION.
            Defined as wxMINIMIZE_BOX |  wxMAXIMIZE_BOX |  wxTHICK_FRAME |
            wxSYSTEM_MENU |  wxCAPTION.

-    @style{wxHSCROLL}:
+    @style{wxHSCROLL}

            Displays a horizontal scrollbar in the client window, allowing the
            user to view child frames that are off the current view.
            Displays a horizontal scrollbar in the client window, allowing the
            user to view child frames that are off the current view.

-    @style{wxICONIZE}:
+    @style{wxICONIZE}

            Display the frame iconized (minimized) (Windows only).
            Display the frame iconized (minimized) (Windows only).

-    @style{wxMAXIMIZE}:
+    @style{wxMAXIMIZE}

            Displays the frame maximized (Windows only).
            Displays the frame maximized (Windows only).

-    @style{wxMAXIMIZE_BOX}:
+    @style{wxMAXIMIZE_BOX}

            Displays a maximize box on the frame (Windows and Motif only).
            Displays a maximize box on the frame (Windows and Motif only).

-    @style{wxMINIMIZE}:
+    @style{wxMINIMIZE}

            Identical to wxICONIZE.
            Identical to wxICONIZE.

-    @style{wxMINIMIZE_BOX}:
+    @style{wxMINIMIZE_BOX}

            Displays a minimize box on the frame (Windows and Motif only).
            Displays a minimize box on the frame (Windows and Motif only).

-    @style{wxRESIZE_BORDER}:
+    @style{wxRESIZE_BORDER}

            Displays a resizeable border around the window (Motif only; for
            Windows, it is implicit in wxTHICK_FRAME).
            Displays a resizeable border around the window (Motif only; for
            Windows, it is implicit in wxTHICK_FRAME).

-    @style{wxSTAY_ON_TOP}:
+    @style{wxSTAY_ON_TOP}

            Stay on top of other windows (Windows only).
            Stay on top of other windows (Windows only).

-    @style{wxSYSTEM_MENU}:
+    @style{wxSYSTEM_MENU}

            Displays a system menu (Windows and Motif only).
            Displays a system menu (Windows and Motif only).

-    @style{wxTHICK_FRAME}:
+    @style{wxTHICK_FRAME}

            Displays a thick frame around the window (Windows and Motif only).
            Displays a thick frame around the window (Windows and Motif only).

-    @style{wxVSCROLL}:
+    @style{wxVSCROLL}

            Displays a vertical scrollbar in the client window, allowing the
            user to view child frames that are off the current view.
            Displays a vertical scrollbar in the client window, allowing the
            user to view child frames that are off the current view.

-    @style{wxFRAME_NO_WINDOW_MENU}:
+    @style{wxFRAME_NO_WINDOW_MENU}

            Under Windows, removes the Window menu that is normally added
            automatically.
     @endStyleTable
            Under Windows, removes the Window menu that is normally added
            automatically.
     @endStyleTable


@@ -101,8 +101,7 @@ public:
     @library{wxcore}
     @category{managedwnd}
 
     @library{wxcore}
     @category{managedwnd}
 

-    @seealso
-    wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog
+    @see wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog

 */
 class wxMDIParentFrame : public wxFrame
 {
 */
 class wxMDIParentFrame : public wxFrame
 {


@@ -110,7 +109,7 @@ public:
     //@{
     /**
         Constructor, creating the window.
     //@{
     /**
         Constructor, creating the window.

-        
+

         @param parent
             The window parent. This should be @NULL.
         @param id
         @param parent
             The window parent. This should be @NULL.
         @param id


@@ -132,12 +131,12 @@ public:
         item,
             allowing the application user to set Motif resource values for
             individual windows.
         item,
             allowing the application user to set Motif resource values for
             individual windows.

-        
+

         @remarks During the construction of the frame, the client window will be
                  created. To use a different class from
                  wxMDIClientWindow, override
                  OnCreateClient().
         @remarks During the construction of the frame, the client window will be
                  created. To use a different class from
                  wxMDIClientWindow, override
                  OnCreateClient().

-        
+

         @see Create(), OnCreateClient()
     */
     wxMDIParentFrame();
         @see Create(), OnCreateClient()
     */
     wxMDIParentFrame();


@@ -156,28 +155,28 @@ public:
 
     /**
         Activates the MDI child following the currently active one.
 
     /**
         Activates the MDI child following the currently active one.

-        
+

         @see ActivatePrevious()
     */
     void ActivateNext();
 
     /**
         Activates the MDI child preceding the currently active one.
         @see ActivatePrevious()
     */
     void ActivateNext();
 
     /**
         Activates the MDI child preceding the currently active one.

-        
+

         @see ActivateNext()
     */
     void ActivatePrevious();
 
     /**
         Arranges any iconized (minimized) MDI child windows.
         @see ActivateNext()
     */
     void ActivatePrevious();
 
     /**
         Arranges any iconized (minimized) MDI child windows.

-        
+

         @see Cascade(), Tile()
     */
     void ArrangeIcons();
 
     /**
         Arranges the MDI child windows in a cascade.
         @see Cascade(), Tile()
     */
     void ArrangeIcons();
 
     /**
         Arranges the MDI child windows in a cascade.

-        
+

         @see Tile(), ArrangeIcons()
     */
     void Cascade();
         @see Tile(), ArrangeIcons()
     */
     void Cascade();


@@ -200,16 +199,16 @@ public:
 
     /**
         This gets the size of the frame 'client area' in pixels.
 
     /**
         This gets the size of the frame 'client area' in pixels.

-        
+

         @param width
             Receives the client width in pixels.
         @param height
             Receives the client height in pixels.
         @param width
             Receives the client width in pixels.
         @param height
             Receives the client height in pixels.

-        
+

         @remarks The client area is the area which may be drawn on by the
                  programmer, excluding title bar, border, status bar,
                  and toolbar if present.
         @remarks The client area is the area which may be drawn on by the
                  programmer, excluding title bar, border, status bar,
                  and toolbar if present.

-        
+

         @see GetToolBar(), SetToolBar(),
              wxMDIClientWindow
     */
         @see GetToolBar(), SetToolBar(),
              wxMDIClientWindow
     */


@@ -217,14 +216,14 @@ public:
 
     /**
         Returns a pointer to the client window.
 
     /**
         Returns a pointer to the client window.

-        
+

         @see OnCreateClient()
     */
     wxMDIClientWindow* GetClientWindow() const;
 
     /**
         Returns the window being used as the toolbar for this frame.
         @see OnCreateClient()
     */
     wxMDIClientWindow* GetClientWindow() const;
 
     /**
         Returns the window being used as the toolbar for this frame.

-        
+

         @see SetToolBar()
     */
     virtual wxWindow* GetToolBar() const;
         @see SetToolBar()
     */
     virtual wxWindow* GetToolBar() const;


@@ -243,11 +242,11 @@ public:
         called,
         due to the way C++ treats virtual functions called from constructors. For
         example:
         called,
         due to the way C++ treats virtual functions called from constructors. For
         example:

-        
+

         @remarks You might wish to derive from wxMDIClientWindow in order to
                  implement different erase behaviour, for example, such
                  as painting a bitmap on the background.
         @remarks You might wish to derive from wxMDIClientWindow in order to
                  implement different erase behaviour, for example, such
                  as painting a bitmap on the background.

-        
+

         @see GetClientWindow(), wxMDIClientWindow
     */
     virtual wxMDIClientWindow* OnCreateClient();
         @see GetClientWindow(), wxMDIClientWindow
     */
     virtual wxMDIClientWindow* OnCreateClient();


@@ -256,14 +255,14 @@ public:
         Sets the window to be used as a toolbar for this
         MDI parent window. It saves the application having to manage the positioning
         of the toolbar MDI client window.
         Sets the window to be used as a toolbar for this
         MDI parent window. It saves the application having to manage the positioning
         of the toolbar MDI client window.

-        
+

         @param toolbar
             Toolbar to manage.
         @param toolbar
             Toolbar to manage.

-        
+

         @remarks When the frame is resized, the toolbar is resized to be the
                  width of the frame client area, and the toolbar height
                  is kept the same.
         @remarks When the frame is resized, the toolbar is resized to be the
                  width of the frame client area, and the toolbar height
                  is kept the same.

-        
+

         @see GetToolBar(), GetClientSize()
     */
     virtual void SetToolBar(wxWindow* toolbar);
         @see GetToolBar(), GetClientSize()
     */
     virtual void SetToolBar(wxWindow* toolbar);


@@ -286,6 +285,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxMDIChildFrame
     @wxheader{mdi.h}
 /**
     @class wxMDIChildFrame
     @wxheader{mdi.h}


@@ -294,37 +294,36 @@ public:
     which is itself a child of wxMDIParentFrame.
 
     @beginStyleTable
     which is itself a child of wxMDIParentFrame.
 
     @beginStyleTable

-    @style{wxCAPTION}:
+    @style{wxCAPTION}

            Puts a caption on the frame.
            Puts a caption on the frame.

-    @style{wxDEFAULT_FRAME_STYLE}:
+    @style{wxDEFAULT_FRAME_STYLE}

            Defined as wxMINIMIZE_BOX |  wxMAXIMIZE_BOX |  wxTHICK_FRAME |
            wxSYSTEM_MENU |  wxCAPTION.
            Defined as wxMINIMIZE_BOX |  wxMAXIMIZE_BOX |  wxTHICK_FRAME |
            wxSYSTEM_MENU |  wxCAPTION.

-    @style{wxICONIZE}:
+    @style{wxICONIZE}

            Display the frame iconized (minimized) (Windows only).
            Display the frame iconized (minimized) (Windows only).

-    @style{wxMAXIMIZE}:
+    @style{wxMAXIMIZE}

            Displays the frame maximized (Windows only).
            Displays the frame maximized (Windows only).

-    @style{wxMAXIMIZE_BOX}:
+    @style{wxMAXIMIZE_BOX}

            Displays a maximize box on the frame (Windows and Motif only).
            Displays a maximize box on the frame (Windows and Motif only).

-    @style{wxMINIMIZE}:
+    @style{wxMINIMIZE}

            Identical to wxICONIZE.
            Identical to wxICONIZE.

-    @style{wxMINIMIZE_BOX}:
+    @style{wxMINIMIZE_BOX}

            Displays a minimize box on the frame (Windows and Motif only).
            Displays a minimize box on the frame (Windows and Motif only).

-    @style{wxRESIZE_BORDER}:
+    @style{wxRESIZE_BORDER}

            Displays a resizeable border around the window (Motif only; for
            Windows, it is implicit in wxTHICK_FRAME).
            Displays a resizeable border around the window (Motif only; for
            Windows, it is implicit in wxTHICK_FRAME).

-    @style{wxSTAY_ON_TOP}:
+    @style{wxSTAY_ON_TOP}

            Stay on top of other windows (Windows only).
            Stay on top of other windows (Windows only).

-    @style{wxSYSTEM_MENU}:
+    @style{wxSYSTEM_MENU}

            Displays a system menu (Windows and Motif only).
            Displays a system menu (Windows and Motif only).

-    @style{wxTHICK_FRAME}:
+    @style{wxTHICK_FRAME}

            Displays a thick frame around the window (Windows and Motif only).
     @endStyleTable
 
     @library{wxcore}
     @category{managedwnd}
 
            Displays a thick frame around the window (Windows and Motif only).
     @endStyleTable
 
     @library{wxcore}
     @category{managedwnd}
 

-    @seealso
-    wxMDIClientWindow, wxMDIParentFrame, wxFrame
+    @see wxMDIClientWindow, wxMDIParentFrame, wxFrame

 */
 class wxMDIChildFrame : public wxFrame
 {
 */
 class wxMDIChildFrame : public wxFrame
 {


@@ -332,7 +331,7 @@ public:
     //@{
     /**
         Constructor, creating the window.
     //@{
     /**
         Constructor, creating the window.

-        
+

         @param parent
             The window parent. This should not be @NULL.
         @param id
         @param parent
             The window parent. This should not be @NULL.
         @param id


@@ -354,9 +353,9 @@ public:
         item,
             allowing the application user to set Motif resource values for
             individual windows.
         item,
             allowing the application user to set Motif resource values for
             individual windows.

-        
+

         @remarks None.
         @remarks None.

-        
+

         @see Create()
     */
     wxMDIChildFrame();
         @see Create()
     */
     wxMDIChildFrame();


@@ -375,7 +374,7 @@ public:
 
     /**
         Activates this MDI child frame.
 
     /**
         Activates this MDI child frame.

-        
+

         @see Maximize(), Restore()
     */
     void Activate();
         @see Maximize(), Restore()
     */
     void Activate();


@@ -393,7 +392,7 @@ public:
 
     /**
         Maximizes this MDI child frame.
 
     /**
         Maximizes this MDI child frame.

-        
+

         @see Activate(), Restore()
     */
     void Maximize(bool maximize);
         @see Activate(), Restore()
     */
     void Maximize(bool maximize);


@@ -403,3 +402,4 @@ public:
     */
     void Restore();
 };
     */
     void Restore();
 };

+