Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxMDIClientWindow (3erl)

Name

wxMDIClientWindow - Functions for wxMDIClientWindow class

Synopsis

Please see following description for synopsis

Description

wxMDIClientWindow(3)       Erlang Module Definition       wxMDIClientWindow(3)



NAME
       wxMDIClientWindow - Functions for wxMDIClientWindow class

DESCRIPTION
       An  MDI  client window is a child of wxMDIParentFrame, and manages zero
       or more wxMDIChildFrame objects.

       The client window is the area where MDI child windows exist. It doesn't
       have  to  cover  the whole parent frame; other windows such as toolbars
       and a help window might coexist with it. There can be scrollbars  on  a
       client window, which are controlled by the parent window style.

       The wxMDIClientWindow class is usually adequate without further deriva-
       tion, and it is created automatically when the MDI parent frame is cre-
       ated.  If  the  application  needs  to derive a new class, the function
       wxMDIParentFrame::OnCreateClient() (not  implemented  in  wx)  must  be
       overridden  in order to give an opportunity to use a different class of
       client window.

       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.

       See: wxMDIChildFrame, wxMDIParentFrame, wxFrame

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

       wxWidgets docs: wxMDIClientWindow

DATA TYPES
       wxMDIClientWindow() = wx:wx_object()

EXPORTS
       new() -> wxMDIClientWindow()

              Default constructor.

              Objects of this class are only created by wxMDIParentFrame which
              uses the default constructor and  calls  createClient/3  immedi-
              ately afterwards.

       createClient(This, Parent) -> boolean()

              Types:

                 This = wxMDIClientWindow()
                 Parent = wxMDIParentFrame:wxMDIParentFrame()

       createClient(This, Parent, Options :: [Option]) -> boolean()

              Types:

                 This = wxMDIClientWindow()
                 Parent = wxMDIParentFrame:wxMDIParentFrame()
                 Option = {style, integer()}

              Called by wxMDIParentFrame immediately after creating the client
              window.

              This function may be overridden in the  derived  class  but  the
              base class version must usually be called first to really create
              the window.

       destroy(This :: wxMDIClientWindow()) -> ok

              Destroys the object.



wxWidgets team.                    wx 2.1.1               wxMDIClientWindow(3)