View Source wxMDIChildFrame (wx v2.4.2)

Functions for wxMDIChildFrame class

An MDI child frame is a frame that can only exist inside a wxMDIClientWindow, which is itself a child of wxMDIParentFrame.

Styles

This class supports the following styles:

All of the standard wxFrame styles can be used but most of them are ignored by TDI-based MDI implementations.

Remark: Although internally an MDI child frame is a child of the MDI client window, in wxWidgets you create it as a child of wxMDIParentFrame. In fact, you can usually forget that the client window exists. MDI child frames are clipped to the area of the MDI client window, and may be iconized on the client window. You can associate a menubar with a child frame as usual, although an MDI child doesn't display its menubar under its own title bar. The MDI parent frame's menubar will be changed to reflect the currently active child frame. If there are currently no children, the parent frame's own menubar will be displayed.

See: wxMDIClientWindow, wxMDIParentFrame, wxFrame

This class is derived (and can use functions) from: wxFrame wxTopLevelWindow wxWindow wxEvtHandler

wxWidgets docs: wxMDIChildFrame

Summary

Types

wxMDIChildFrame()

Functions

activate(This)

Activates this MDI child frame.

create(This, Parent, Id, Title)

create/5

Used in two-step frame construction.

destroy(This)

Destructor.

maximize(This)

maximize/2

Maximizes this MDI child frame.

new()

Default constructor.

new(Parent, Id, Title)

new/4

Constructor, creating the window.

restore(This)

Restores this MDI child frame (unmaximizes).

Types

wxMDIChildFrame()

-type wxMDIChildFrame() :: wx:wx_object().

Functions

activate(This)

-spec activate(This) -> ok when This :: wxMDIChildFrame().

Activates this MDI child frame.

See: maximize/2, restore/1

create(This, Parent, Id, Title)

-spec create(This, Parent, Id, Title) -> boolean()
          when
              This :: wxMDIChildFrame(),
              Parent :: wxMDIParentFrame:wxMDIParentFrame(),
              Id :: integer(),
              Title :: unicode:chardata().

create/5

-spec create(This, Parent, Id, Title, [Option]) -> boolean()
          when
              This :: wxMDIChildFrame(),
              Parent :: wxMDIParentFrame:wxMDIParentFrame(),
              Id :: integer(),
              Title :: unicode:chardata(),
              Option ::
                  {pos, {X :: integer(), Y :: integer()}} |
                  {size, {W :: integer(), H :: integer()}} |
                  {style, integer()}.

Used in two-step frame construction.

See new/4 for further details.

destroy(This)

-spec destroy(This :: wxMDIChildFrame()) -> ok.

Destructor.

Destroys all child windows and menu bar if present.

maximize(This)

-spec maximize(This) -> ok when This :: wxMDIChildFrame().

maximize/2

-spec maximize(This, [Option]) -> ok when This :: wxMDIChildFrame(), Option :: {maximize, boolean()}.

Maximizes this MDI child frame.

This function doesn't do anything if IsAlwaysMaximized() (not implemented in wx) returns true.

See: activate/1, restore/1

new()

-spec new() -> wxMDIChildFrame().

Default constructor.

new(Parent, Id, Title)

-spec new(Parent, Id, Title) -> wxMDIChildFrame()
       when
           Parent :: wxMDIParentFrame:wxMDIParentFrame(),
           Id :: integer(),
           Title :: unicode:chardata().

new/4

-spec new(Parent, Id, Title, [Option]) -> wxMDIChildFrame()
       when
           Parent :: wxMDIParentFrame:wxMDIParentFrame(),
           Id :: integer(),
           Title :: unicode:chardata(),
           Option ::
               {pos, {X :: integer(), Y :: integer()}} |
               {size, {W :: integer(), H :: integer()}} |
               {style, integer()}.

Constructor, creating the window.

See: create/5

restore(This)

-spec restore(This) -> ok when This :: wxMDIChildFrame().

Restores this MDI child frame (unmaximizes).

This function doesn't do anything if IsAlwaysMaximized() (not implemented in wx) returns true.

See: activate/1, maximize/2