Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxOverlay (3erl)

Name

wxOverlay - Functions for wxOverlay class

Synopsis

Please see following description for synopsis

Description

wxOverlay(3)               Erlang Module Definition               wxOverlay(3)



NAME
       wxOverlay - Functions for wxOverlay class

DESCRIPTION
       Creates  an overlay over an existing window, allowing for manipulations
       like rubberbanding, etc. On  wxOSX  the  overlay  is  implemented  with
       native  platform  APIs,  on  the  other platforms it is simulated using
       wxMemoryDC.

       See: wxDCOverlay, wxDC

       wxWidgets docs: wxOverlay

DATA TYPES
       wxOverlay() = wx:wx_object()

EXPORTS
       new() -> wxOverlay()

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

       reset(This) -> ok

              Types:

                 This = wxOverlay()

              Clears the overlay without restoring the former state.

              To be done, for  example,  when  the  window  content  has  been
              changed and repainted.



wxWidgets team.                    wx 2.1.1                       wxOverlay(3)