Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxAuiDockArt (3erl)

Name

wxAuiDockArt - Functions for wxAuiDockArt class

Synopsis

Please see following description for synopsis

Description

wxAuiDockArt(3)            Erlang Module Definition            wxAuiDockArt(3)



NAME
       wxAuiDockArt - Functions for wxAuiDockArt class

DESCRIPTION
       wxAuiDockArt  is  part  of  the  wxAUI  class framework. See also over-
       view_aui.

       wxAuiDockArt is the art provider: provides all drawing functionality to
       the  wxAui  dock  manager. This allows the dock manager to have a plug-
       gable look-and-feel.

       By default, a wxAuiManager  uses  an  instance  of  this  class  called
       wxAuiDefaultDockArt  (not  implemented in wx) which provides bitmap art
       and a colour scheme that is adapted to the major platforms'  look.  You
       can  either  derive  from  that class to alter its behaviour or write a
       completely new dock art class.  Call  wxAuiManager:setArtProvider/2  to
       force wxAUI to use your new dock art provider.

       See: wxAuiManager, wxAuiPaneInfo

       wxWidgets docs: wxAuiDockArt

DATA TYPES
       wxAuiDockArt() = wx:wx_object()

EXPORTS
       getColour(This, Id) -> wx:wx_colour4()

              Types:

                 This = wxAuiDockArt()
                 Id = integer()

              Get the colour of a certain setting.

              id can be one of the colour values of wxAuiPaneDockArtSetting.

       getFont(This, Id) -> wxFont:wxFont()

              Types:

                 This = wxAuiDockArt()
                 Id = integer()

              Get a font setting.

       getMetric(This, Id) -> integer()

              Types:

                 This = wxAuiDockArt()
                 Id = integer()

              Get the value of a certain setting.

              id can be one of the size values of wxAuiPaneDockArtSetting.

       setColour(This, Id, Colour) -> ok

              Types:

                 This = wxAuiDockArt()
                 Id = integer()
                 Colour = wx:wx_colour()

              Set a certain setting with the value colour.

              id can be one of the colour values of wxAuiPaneDockArtSetting.

       setFont(This, Id, Font) -> ok

              Types:

                 This = wxAuiDockArt()
                 Id = integer()
                 Font = wxFont:wxFont()

              Set a font setting.

       setMetric(This, Id, New_val) -> ok

              Types:

                 This = wxAuiDockArt()
                 Id = New_val = integer()

              Set a certain setting with the value new_val.

              id can be one of the size values of wxAuiPaneDockArtSetting.



wxWidgets team.                    wx 2.1.1                    wxAuiDockArt(3)