Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxSpinEvent (3erl)

Name

wxSpinEvent - Functions for wxSpinEvent class

Synopsis

Please see following description for synopsis

Description

wxSpinEvent(3)             Erlang Module Definition             wxSpinEvent(3)



NAME
       wxSpinEvent - Functions for wxSpinEvent class

DESCRIPTION
       This  event  class is used for the events generated by wxSpinButton and
       wxSpinCtrl.

       See: wxSpinButton, and, wxSpinCtrl

       This class is derived  (and  can  use  functions)  from:  wxNotifyEvent
       wxCommandEvent wxEvent

       wxWidgets docs: wxSpinEvent

EVENTS
       Use  wxEvtHandler:connect/3 with wxSpinEventType to subscribe to events
       of this type.

DATA TYPES
       wxSpinEvent() = wx:wx_object()

       wxSpin() =
           #wxSpin{type = wxSpinEvent:wxSpinEventType(),
                   commandInt = integer()}

       wxSpinEventType() =
           command_spinctrl_updated | spin_up | spin_down | spin

EXPORTS
       getPosition(This) -> integer()

              Types:

                 This = wxSpinEvent()

              Retrieve the current spin button or control value.

       setPosition(This, Pos) -> ok

              Types:

                 This = wxSpinEvent()
                 Pos = integer()

              Set the value associated with the event.



wxWidgets team.                    wx 2.1.1                     wxSpinEvent(3)