// Name: mdi.h
// Purpose: interface of wxMDIClientWindow
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
be overridden in order to give an opportunity to use a different class of client
window.
- Under Windows 95, the client window will automatically have a sunken border style
+ Under wxMSW, the client window will automatically have a sunken border style
when the active child is not maximized, and no border style when a child is maximized.
@library{wxcore}
@param title
The caption to be displayed on the frame's title bar.
@param pos
- The window position. The value @c wxDefaultPosition indicates a
+ The window position. The value ::wxDefaultPosition indicates a
default position, chosen by either the windowing system or
wxWidgets, depending on platform.
@param size
- The window size. The value @c wxDefaultSize indicates a default
+ The window size. The value ::wxDefaultSize indicates a default
size, chosen by either the windowing system or wxWidgets, depending
on platform.
@param style
@remarks
- Under Windows 95, the client window will automatically have a sunken
+ Under wxMSW, the client window will automatically have a sunken
border style when the active child is not maximized, and no border
style when a child is maximized.
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
- const wxString& name = "frame");
+ const wxString& name = wxFrameNameStr);
/**
Destructor.
If there are any children at all this function returns a non-@NULL
pointer.
*/
- wxMDIChildFrame* GetActiveChild() const;
+ virtual wxMDIChildFrame* GetActiveChild() const;
/**
Returns a pointer to the client window.
@see OnCreateClient()
*/
- wxWindow *GetClientWindow() const;
+ wxMDIClientWindowBase* GetClientWindow() const;
/**
Returns the current MDI Window menu.
@code
frame = new MyParentFrame;
- frame->Create(parent, myParentFrameId, wxT("My Parent Frame"));
+ frame->Create(parent, myParentFrameId, "My Parent Frame");
@endcode
@remarks
window style but this function also allows to do it by passing @NULL
pointer as @a menu.
+ The menu may include the items with the following standard identifiers
+ (but may use arbitrary text and help strings and bitmaps for them):
+ - @c wxID_MDI_WINDOW_CASCADE
+ - @c wxID_MDI_WINDOW_TILE_HORZ
+ - @c wxID_MDI_WINDOW_TILE_VERT
+ - @c wxID_MDI_WINDOW_ARRANGE_ICONS
+ - @c wxID_MDI_WINDOW_PREV
+ - @c wxID_MDI_WINDOW_NEXT
+ All of which are handled by wxMDIParentFrame itself. If any other
+ commands are used in the menu, the derived frame should handle them.
+
This function is currently not available under OS X.
@param menu
The menu to be used instead of the standard MDI Window menu or @NULL.
*/
- void SetWindowMenu(wxMenu *menu);
+ virtual void SetWindowMenu(wxMenu* menu);
/**
Tiles the MDI child windows either horizontally or vertically depending
@param title
The caption to be displayed on the frame's title bar.
@param pos
- The window position. The value @c wxDefaultPosition indicates a default position,
+ The window position. The value ::wxDefaultPosition indicates a default position,
chosen by either the windowing system or wxWidgets, depending on platform.
@param size
- The window size. The value @c wxDefaultSize indicates a default size, chosen by
+ The window size. The value ::wxDefaultSize indicates a default size, chosen by
either the windowing system or wxWidgets, depending on platform.
@param style
The window style. See wxMDIChildFrame.
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = "frame");
+ const wxString& name = wxFrameNameStr);
/**
Destructor. Destroys all child windows and menu bar if present.