Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxStaticBitmap (3erl)

Name

wxStaticBitmap - Functions for wxStaticBitmap class

Synopsis

Please see following description for synopsis

Description

wxStaticBitmap(3)          Erlang Module Definition          wxStaticBitmap(3)



NAME
       wxStaticBitmap - Functions for wxStaticBitmap class

DESCRIPTION
       A  static  bitmap  control displays a bitmap. Native implementations on
       some platforms are only meant for display of the  small  icons  in  the
       dialog boxes.

       If  you  want  to  display  larger images portably, you may use generic
       implementation        wxGenericStaticBitmap         declared         in
       <wx/generic/statbmpg.h>.

       Notice that for the best results, the size of the control should be the
       same as the size of the image displayed in it, as happens by default if
       it's  not resized explicitly. Otherwise, behaviour depends on the plat-
       form: under MSW, the bitmap is drawn centred inside the control,  while
       elsewhere  it  is  drawn  at  the  origin  of  the control. You can use
       SetScaleMode() (not implemented in wx) to  control  how  the  image  is
       scaled inside the control.

       See: wxBitmap

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

       wxWidgets docs: wxStaticBitmap

DATA TYPES
       wxStaticBitmap() = wx:wx_object()

EXPORTS
       new() -> wxStaticBitmap()

              Default constructor.

       new(Parent, Id, Label) -> wxStaticBitmap()

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Label = wxBitmap:wxBitmap()

       new(Parent, Id, Label, Options :: [Option]) -> wxStaticBitmap()

              Types:

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

              Constructor, creating and showing a static bitmap control.

              See: create/5

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

              Types:

                 This = wxStaticBitmap()
                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Label = wxBitmap:wxBitmap()

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

              Types:

                 This = wxStaticBitmap()
                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Label = wxBitmap:wxBitmap()
                 Option =
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {style, integer()}

              Creation function, for two-step construction.

              For details see new/4.

       getBitmap(This) -> wxBitmap:wxBitmap()

              Types:

                 This = wxStaticBitmap()

              Returns the bitmap currently used in the control.

              Notice that this method can be called  even  if  SetIcon()  (not
              implemented in wx) had been used.

              See: setBitmap/2

       setBitmap(This, Label) -> ok

              Types:

                 This = wxStaticBitmap()
                 Label = wxBitmap:wxBitmap()

              Sets the bitmap label.

              See: getBitmap/1

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

              Destroys the object.



wxWidgets team.                    wx 2.1.1                  wxStaticBitmap(3)