wxMDIChildFrame(3)

πŸ“¦
version 29.0.6 Β· 3 versions
, in ubuntu stonking

πŸ’… wxMDIChildFrame πŸ’…

okay bestie, so wxMDIChildFrame is an Erlang module in the wx family (manual section 3, the "Erlang Module Definition" corner of the world 🌍) β€” and it does exactly what the name says with a lil twist, so let's get into it.


✨ NAME ✨

wxMDIChildFrame β€” an MDI child frame is a frame that can only exist inside a wxMDIClientWindow, and that client window is itself a child of wxMDIParentFrame. it's giving nesting dolls, fr fr πŸͺ†


🌸 DESCRIPTION 🌸

πŸŽ€ 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. (so you can pass them, they just get the silent treatment πŸ™ˆ)
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 at all. 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


πŸ¦‹ DATA TYPES πŸ¦‹

wxMDIChildFrame() :: wx:wx_object().

πŸ’– FUNCTIONS πŸ’–

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

Activates this MDI child frame. put it on center stage, main character energy ⭐

See:

  • maximize/2
  • restore/1
  • 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. the slow-burn build, iykyk 🫢

See new/4 for further details.

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

Destroys the object. bye bestie πŸ’€βœ¨ (not mean, just permanent)

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

Maximizes this MDI child frame. go big or go home πŸ“ˆ

This function doesn't do anything if IsAlwaysMaximized() (not implemented in wx) returns true. so if that's the vibe, this call is lowkey a no-op πŸ™ƒ

See:

  • activate/1
  • restore/1
  • new() -> wxMDIChildFrame().

Default constructor. the blank canvas 🎨

  • 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) -> ok when This :: wxMDIChildFrame().

Restores this MDI child frame (unmaximizes). come back down to earth, bestie 🧚

This function doesn't do anything if IsAlwaysMaximized() (not implemented in wx) returns true. again β€” no-op city πŸ™οΈ

See:

  • activate/1
  • maximize/2

aaaand that's the whole page, no notes πŸ’… brought to you by Ericsson AB, version wx 2.6 β€” that's the source and the version stamped on this lil manual page, so if you see wxMDIChildFrame(3) floating around in the wilds of your man pages, you already know who made it and which release it rides with πŸŽ€βœ¨

πŸ“¦ where this page comes from