Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxMiniFrame (3erl)

Name

wxMiniFrame - Functions for wxMiniFrame class

Synopsis

Please see following description for synopsis

Description

wxMiniFrame(3)             Erlang Module Definition             wxMiniFrame(3)



NAME
       wxMiniFrame - Functions for wxMiniFrame class

DESCRIPTION
       A  miniframe  is  a  frame  with  a small title bar. It is suitable for
       floating toolbars that must not take up too much screen area.

       An example of mini frame can be seen in the page_samples_dialogs  using
       the "Mini frame" command of the "Generic dialogs" submenu.

       Styles

       This class supports the following styles:

       Remark:  This  class has miniframe functionality under Windows and GTK,
       i.e. the presence of mini frame will not be noted in the task  bar  and
       focus  behaviour  is  different.  On other platforms, it behaves like a
       normal frame.

       See: wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog

       This class is derived (and can use functions) from: wxFrame wxTopLevel-
       Window wxWindow wxEvtHandler

       wxWidgets docs: wxMiniFrame

DATA TYPES
       wxMiniFrame() = wx:wx_object()

EXPORTS
       new() -> wxMiniFrame()

              Default ctor.

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

              Types:

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

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

              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:  The  frame  behaves  like a normal frame on non-Windows
              platforms.

              See: create/5

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

              Destructor.

              Destroys all child windows and menu bar if present.

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

              Types:

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

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

              Types:

                 This = wxMiniFrame()
                 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.



wxWidgets team.                    wx 2.1.1                     wxMiniFrame(3)