Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxDCOverlay (3erl)

Name

wxDCOverlay - Functions for wxDCOverlay class

Synopsis

Please see following description for synopsis

Description

wxDCOverlay(3)             Erlang Module Definition             wxDCOverlay(3)



NAME
       wxDCOverlay - Functions for wxDCOverlay class

DESCRIPTION
       Connects an overlay with a drawing DC.

       See: wxOverlay, wxDC

       wxWidgets docs: wxDCOverlay

DATA TYPES
       wxDCOverlay() = wx:wx_object()

EXPORTS
       new(Overlay, Dc) -> wxDCOverlay()

              Types:

                 Overlay = wxOverlay:wxOverlay()
                 Dc = wxDC:wxDC()

              Convenience  wrapper that behaves the same using the entire area
              of the dc.

       new(Overlay, Dc, X, Y, Width, Height) -> wxDCOverlay()

              Types:

                 Overlay = wxOverlay:wxOverlay()
                 Dc = wxDC:wxDC()
                 X = Y = Width = Height = integer()

              Connects this overlay to the corresponding drawing  dc,  if  the
              overlay is not initialized yet this call will do so.

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

              Removes the connection between the overlay and the dc.

       clear(This) -> ok

              Types:

                 This = wxDCOverlay()

              Clears the layer, restoring the state at the last init.



wxWidgets team.                    wx 2.1.1                     wxDCOverlay(3)