Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxStaticBoxSizer (3erl)

Name

wxStaticBoxSizer - Functions for wxStaticBoxSizer class

Synopsis

Please see following description for synopsis

Description

wxStaticBoxSizer(3)        Erlang Module Definition        wxStaticBoxSizer(3)



NAME
       wxStaticBoxSizer - Functions for wxStaticBoxSizer class

DESCRIPTION
       wxStaticBoxSizer  is  a sizer derived from wxBoxSizer but adds a static
       box around the sizer.

       The static box may be either created independently  or  the  sizer  may
       create  it  itself  as  a  convenience. In any case, the sizer owns the
       wxStaticBox control and will delete it in the wxStaticBoxSizer destruc-
       tor.

       Note  that  since wxWidgets 2.9.1 you are encouraged to create the win-
       dows which are added to wxStaticBoxSizer  as  children  of  wxStaticBox
       itself, see this class documentation for more details.

       Example of use of this class:

       See: wxSizer, wxStaticBox, wxBoxSizer, Overview sizer

       This class is derived (and can use functions) from: wxBoxSizer wxSizer

       wxWidgets docs: wxStaticBoxSizer

DATA TYPES
       wxStaticBoxSizer() = wx:wx_object()

EXPORTS
       new(Orient, Parent) -> wxStaticBoxSizer()

       new(Box, Orient) -> wxStaticBoxSizer()

              Types:

                 Box = wxStaticBox:wxStaticBox()
                 Orient = integer()

              This constructor uses an already existing static box.

       new(Orient, Parent, Options :: [Option]) -> wxStaticBoxSizer()

              Types:

                 Orient = integer()
                 Parent = wxWindow:wxWindow()
                 Option = {label, unicode:chardata()}

              This  constructor  creates a new static box with the given label
              and parent window.

       getStaticBox(This) -> wxStaticBox:wxStaticBox()

              Types:

                 This = wxStaticBoxSizer()

              Returns the static box associated with the sizer.

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

              Destroys the object.



wxWidgets team.                    wx 2.1.1                wxStaticBoxSizer(3)