Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxCheckListBox (3erl)

Name

wxCheckListBox - Functions for wxCheckListBox class

Synopsis

Please see following description for synopsis

Description

wxCheckListBox(3)          Erlang Module Definition          wxCheckListBox(3)



NAME
       wxCheckListBox - Functions for wxCheckListBox class

DESCRIPTION
       A wxCheckListBox is like a wxListBox, but allows items to be checked or
       unchecked.

       When using this class under Windows wxWidgets  must  be  compiled  with
       wxUSE_OWNER_DRAWN set to 1.

       See: wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent

       This  class  is  derived (and can use functions) from: wxListBox wxCon-
       trolWithItems wxControl wxWindow wxEvtHandler

       wxWidgets docs: wxCheckListBox

EVENTS
       Event types emitted from this class: command_checklistbox_toggled

DATA TYPES
       wxCheckListBox() = wx:wx_object()

EXPORTS
       new() -> wxCheckListBox()

              Default constructor.

       new(Parent, Id) -> wxCheckListBox()

              Types:

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

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

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Option =
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {choices, [unicode:chardata()]} |
                     {style, integer()} |
                     {validator, wx:wx_object()}

              Constructor, creating and showing a list box.

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

              Destructor, destroying the list box.

       check(This, Item) -> ok

              Types:

                 This = wxCheckListBox()
                 Item = integer()

       check(This, Item, Options :: [Option]) -> ok

              Types:

                 This = wxCheckListBox()
                 Item = integer()
                 Option = {check, boolean()}

              Checks the given item.

              Note that calling this method does not result in a  wxEVT_CHECK-
              LISTBOX event being emitted.

       isChecked(This, Item) -> boolean()

              Types:

                 This = wxCheckListBox()
                 Item = integer()

              Returns true if the given item is checked, false otherwise.



wxWidgets team.                    wx 2.1.1                  wxCheckListBox(3)