X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..7c0d297a1f761de31d3a4ac924fa2080b5bbaf41:/interface/mdi.h?ds=inline diff --git a/interface/mdi.h b/interface/mdi.h index 582641d692..3d5f3b80bc 100644 --- a/interface/mdi.h +++ b/interface/mdi.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: mdi.h -// Purpose: documentation for wxMDIClientWindow class +// Purpose: interface of wxMDIClientWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxMDIChildFrame, wxMDIParentFrame, wxFrame + @see wxMDIChildFrame, wxMDIParentFrame, wxFrame */ class wxMDIClientWindow : public wxWindow { @@ -25,15 +24,15 @@ public: //@{ /** Constructor, creating the window. - + @param parent The window parent. @param style The window style. Currently unused. - + @remarks The second style of constructor is called within wxMDIParentFrame::OnCreateClient. - + @see wxMDIParentFrame::wxMDIParentFrame, wxMDIParentFrame::OnCreateClient */ wxMDIClientWindow(); @@ -53,6 +52,7 @@ public: }; + /** @class wxMDIParentFrame @wxheader{mdi.h} @@ -63,37 +63,37 @@ public: and is used in many popular Windows applications, such as Microsoft Word(TM). @beginStyleTable - @style{wxCAPTION}: + @style{wxCAPTION} 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. - @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. - @style{wxICONIZE}: + @style{wxICONIZE} Display the frame iconized (minimized) (Windows only). - @style{wxMAXIMIZE}: + @style{wxMAXIMIZE} Displays the frame maximized (Windows only). - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the frame (Windows and Motif only). - @style{wxMINIMIZE}: + @style{wxMINIMIZE} Identical to wxICONIZE. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} 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). - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} Stay on top of other windows (Windows only). - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} 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). - @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. - @style{wxFRAME_NO_WINDOW_MENU}: + @style{wxFRAME_NO_WINDOW_MENU} Under Windows, removes the Window menu that is normally added automatically. @endStyleTable @@ -101,8 +101,7 @@ public: @library{wxcore} @category{managedwnd} - @seealso - wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog + @see wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog */ class wxMDIParentFrame : public wxFrame { @@ -110,7 +109,7 @@ public: //@{ /** Constructor, creating the window. - + @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. - + @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(); @@ -156,28 +155,28 @@ public: /** Activates the MDI child following 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 Cascade(), Tile() */ void ArrangeIcons(); /** Arranges the MDI child windows in a cascade. - + @see Tile(), ArrangeIcons() */ void Cascade(); @@ -196,45 +195,45 @@ public: /** Returns a pointer to the active MDI child, if there is one. */ - wxMDIChildFrame* GetActiveChild(); + wxMDIChildFrame* GetActiveChild() const; /** 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. - + @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 */ - virtual void GetClientSize(int* width, int* height); + virtual void GetClientSize(int* width, int* height) const; /** Returns a pointer to the client window. - + @see OnCreateClient() */ - wxMDIClientWindow* GetClientWindow(); + wxMDIClientWindow* GetClientWindow() const; /** Returns the window being used as the toolbar for this frame. - + @see SetToolBar() */ - virtual wxWindow* GetToolBar(); + virtual wxWindow* GetToolBar() const; /** Returns the current Window menu (added by wxWidgets to the menubar). This function is available under Windows only. */ - wxMenu* GetWindowMenu(); + wxMenu* GetWindowMenu() const; /** Override this to return a different kind of client window. If you override this @@ -243,11 +242,11 @@ public: 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. - + @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. - + @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. - + @see GetToolBar(), GetClientSize() */ virtual void SetToolBar(wxWindow* toolbar); @@ -286,6 +285,7 @@ public: }; + /** @class wxMDIChildFrame @wxheader{mdi.h} @@ -294,37 +294,36 @@ public: which is itself a child of wxMDIParentFrame. @beginStyleTable - @style{wxCAPTION}: + @style{wxCAPTION} 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. - @style{wxICONIZE}: + @style{wxICONIZE} Display the frame iconized (minimized) (Windows only). - @style{wxMAXIMIZE}: + @style{wxMAXIMIZE} Displays the frame maximized (Windows only). - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the frame (Windows and Motif only). - @style{wxMINIMIZE}: + @style{wxMINIMIZE} Identical to wxICONIZE. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} 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). - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} Stay on top of other windows (Windows only). - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} 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} - @seealso - wxMDIClientWindow, wxMDIParentFrame, wxFrame + @see wxMDIClientWindow, wxMDIParentFrame, wxFrame */ class wxMDIChildFrame : public wxFrame { @@ -332,7 +331,7 @@ public: //@{ /** Constructor, creating the window. - + @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. - + @remarks None. - + @see Create() */ wxMDIChildFrame(); @@ -375,7 +374,7 @@ public: /** Activates this MDI child frame. - + @see Maximize(), Restore() */ void Activate(); @@ -393,7 +392,7 @@ public: /** Maximizes this MDI child frame. - + @see Activate(), Restore() */ void Maximize(bool maximize); @@ -403,3 +402,4 @@ public: */ void Restore(); }; +