Provided by: erlang-manpages_25.2.3+dfsg-1_all bug

NAME

       wxFrame - Functions for wxFrame class

DESCRIPTION

       A frame is a window whose size and position can (usually) be changed by the user.

       It  usually  has  thick  borders  and  a title bar, and can optionally contain a menu bar,
       toolbar and status bar. A frame can contain any window that is not a frame or dialog.

       A frame that has  a  status  bar  and  toolbar,  created  via  the  createStatusBar/2  and
       createToolBar/2  functions,  manages  these  windows  and  adjusts  the  value returned by
       wxWindow:getClientSize/1 to reflect the remaining size available to application windows.

       Remark: An application should normally define an wxCloseEvent handler  for  the  frame  to
       respond  to  system  close  events, for example so that related data and subwindows can be
       cleaned up.

       Default event processing

       wxFrame processes the following events:

       Styles

       This class supports the following styles:

       See also the overview_windowstyles.

       Extra Styles

       This class supports the following extra styles:

       See: wxMDIParentFrame, wxMDIChildFrame, wxMiniFrame, wxDialog

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

       wxWidgets docs: wxFrame

EVENTS

       Event types  emitted  from  this  class:  close_window,  iconize,  menu_open,  menu_close,
       menu_highlight

DATA TYPES

       wxFrame() = wx:wx_object()

EXPORTS

       new() -> wxFrame()

              Default constructor.

       new(Parent, Id, Title) -> wxFrame()

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Title = unicode:chardata()

       new(Parent, Id, Title, Options :: [Option]) -> wxFrame()

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Title = unicode:chardata()
                 Option =
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {style, integer()}

              Constructor, creating the window.

              Remark:  For Motif, MWM (the Motif Window Manager) should be running for any window
              styles to work (otherwise all styles take effect).

              See: create/5

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

              Destructor.

              Destroys all child windows and menu bar if present.

              See overview_windowdeletion for more info.

       create(This, Parent, Id, Title) -> boolean()

              Types:

                 This = wxFrame()
                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Title = unicode:chardata()

       create(This, Parent, Id, Title, Options :: [Option]) -> boolean()

              Types:

                 This = wxFrame()
                 Parent = wxWindow:wxWindow()
                 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.

       createStatusBar(This) -> wxStatusBar:wxStatusBar()

              Types:

                 This = wxFrame()

       createStatusBar(This, Options :: [Option]) ->
                          wxStatusBar:wxStatusBar()

              Types:

                 This = wxFrame()
                 Option =
                     {number, integer()} | {style, integer()} | {id, integer()}

              Creates a status bar at the bottom of the frame.

              Return: A pointer to the status bar if it was created successfully, NULL otherwise.

              Remark: The width of the status bar is the  whole  width  of  the  frame  (adjusted
              automatically  when  resizing), and the height and text size are chosen by the host
              windowing system.

              See: setStatusText/3, OnCreateStatusBar() (not implemented in wx), getStatusBar/1

       createToolBar(This) -> wxToolBar:wxToolBar()

              Types:

                 This = wxFrame()

       createToolBar(This, Options :: [Option]) -> wxToolBar:wxToolBar()

              Types:

                 This = wxFrame()
                 Option = {style, integer()} | {id, integer()}

              Creates a toolbar at the top or left of the frame.

              Return: A pointer to the toolbar if it was created successfully, NULL otherwise.

              Remark: By default, the toolbar is an instance of wxToolBar.  To  use  a  different
              class,  override OnCreateToolBar() (not implemented in wx). When a toolbar has been
              created with this function, or made known to the frame with setToolBar/2, the frame
              will   manage   the   toolbar   position   and   adjust   the   return  value  from
              wxWindow:getClientSize/1 to reflect the available space  for  application  windows.
              Under Pocket PC, you should always use this function for creating the toolbar to be
              managed by the frame, so that wxWidgets can use a  combined  menubar  and  toolbar.
              Where you manage your own toolbars, create a wxToolBar as usual.

              See:  createStatusBar/2,  OnCreateToolBar()  (not implemented in wx), setToolBar/2,
              getToolBar/1

       getClientAreaOrigin(This) -> {X :: integer(), Y :: integer()}

              Types:

                 This = wxFrame()

              Returns the origin of the frame client area (in client coordinates).

              It may be different from (0, 0) if the frame has a toolbar.

       getMenuBar(This) -> wxMenuBar:wxMenuBar()

              Types:

                 This = wxFrame()

              Returns a pointer to the menubar currently associated with the frame (if any).

              See: setMenuBar/2, wxMenuBar, wxMenu

       getStatusBar(This) -> wxStatusBar:wxStatusBar()

              Types:

                 This = wxFrame()

              Returns a pointer to the status bar currently associated with the frame (if any).

              See: createStatusBar/2, wxStatusBar

       getStatusBarPane(This) -> integer()

              Types:

                 This = wxFrame()

              Returns the status bar pane used to display menu and toolbar help.

              See: setStatusBarPane/2

       getToolBar(This) -> wxToolBar:wxToolBar()

              Types:

                 This = wxFrame()

              Returns a pointer to the toolbar currently associated with the frame (if any).

              See: createToolBar/2, wxToolBar, setToolBar/2

       processCommand(This, Id) -> boolean()

              Types:

                 This = wxFrame()
                 Id = integer()

              Simulate a menu command.

       sendSizeEvent(This) -> ok

              Types:

                 This = wxFrame()

       sendSizeEvent(This, Options :: [Option]) -> ok

              Types:

                 This = wxFrame()
                 Option = {flags, integer()}

              This function sends a dummy wxSizeEvent to the window allowing it to re-layout  its
              children positions.

              It  is  sometimes  useful to call this function after adding or deleting a children
              after the frame creation or if a child size changes. Note  that  if  the  frame  is
              using  either  sizers  or constraints for the children layout, it is enough to call
              wxWindow:layout/1 directly and this function should not be used in this case.

              If flags includes wxSEND_EVENT_POST value, this  function  posts  the  event,  i.e.
              schedules it for later processing, instead of dispatching it directly. You can also
              use PostSizeEvent() (not implemented in  wx)  as  a  more  readable  equivalent  of
              calling this function with this flag.

       setMenuBar(This, MenuBar) -> ok

              Types:

                 This = wxFrame()
                 MenuBar = wxMenuBar:wxMenuBar()

              Tells the frame to show the given menu bar.

              Remark:  If  the  frame  is destroyed, the menu bar and its menus will be destroyed
              also, so do not delete the menu bar explicitly (except  by  resetting  the  frame's
              menu bar to another frame or NULL). Under Windows, a size event is generated, so be
              sure to initialize data members properly before calling setMenuBar/2. Note that  on
              some  platforms,  it is not possible to call this function twice for the same frame
              object.

              See: getMenuBar/1, wxMenuBar, wxMenu

       setStatusBar(This, StatusBar) -> ok

              Types:

                 This = wxFrame()
                 StatusBar = wxStatusBar:wxStatusBar()

              Associates a status bar with the frame.

              If statusBar is NULL, then the status bar, if present, is detached from the  frame,
              but not deleted.

              See: createStatusBar/2, wxStatusBar, getStatusBar/1

       setStatusBarPane(This, N) -> ok

              Types:

                 This = wxFrame()
                 N = integer()

              Set the status bar pane used to display menu and toolbar help.

              Using -1 disables help display.

       setStatusText(This, Text) -> ok

              Types:

                 This = wxFrame()
                 Text = unicode:chardata()

       setStatusText(This, Text, Options :: [Option]) -> ok

              Types:

                 This = wxFrame()
                 Text = unicode:chardata()
                 Option = {number, integer()}

              Sets the status bar text and updates the status bar display.

              This  is a simple wrapper for wxStatusBar:setStatusText/3 which doesn't do anything
              if the frame has no status bar, i.e. getStatusBar/1 returns NULL.

              Remark: Use an empty string to clear the status bar.

              See: createStatusBar/2, wxStatusBar

       setStatusWidths(This, Widths_field) -> ok

              Types:

                 This = wxFrame()
                 Widths_field = [integer()]

              Sets the widths of the fields in the status bar.

              Remark: The widths of the variable fields are calculated from the  total  width  of
              all  fields,  minus  the  sum  of widths of the non-variable fields, divided by the
              number of variable fields.

       setToolBar(This, ToolBar) -> ok

              Types:

                 This = wxFrame()
                 ToolBar = wxToolBar:wxToolBar()

              Associates a toolbar with the frame.