Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxMultiChoiceDialog (3erl)

Name

wxMultiChoiceDialog - Functions for wxMultiChoiceDialog class

Synopsis

Please see following description for synopsis

Description

wxMultiChoiceDialog(3)     Erlang Module Definition     wxMultiChoiceDialog(3)



NAME
       wxMultiChoiceDialog - Functions for wxMultiChoiceDialog class

DESCRIPTION
       This class represents a dialog that shows a list of strings, and allows
       the user to select one or more.

       Styles

       This class supports the following styles:

       See: Overview cmndlg, wxSingleChoiceDialog

       This class is derived (and can  use  functions)  from:  wxDialog  wxTo-
       pLevelWindow wxWindow wxEvtHandler

       wxWidgets docs: wxMultiChoiceDialog

DATA TYPES
       wxMultiChoiceDialog() = wx:wx_object()

EXPORTS
       new(Parent, Message, Caption, Choices) -> wxMultiChoiceDialog()

              Types:

                 Parent = wxWindow:wxWindow()
                 Message = Caption = unicode:chardata()
                 Choices = [unicode:chardata()]

       new(Parent, Message, Caption, Choices, Options :: [Option]) ->
              wxMultiChoiceDialog()

              Types:

                 Parent = wxWindow:wxWindow()
                 Message = Caption = unicode:chardata()
                 Choices = [unicode:chardata()]
                 Option =
                     {style,  integer()}  |  {pos, {X :: integer(), Y :: inte-
                 ger()}}

              Constructor taking an array of wxString (not implemented in  wx)
              choices.

              Remark: Use wxDialog:showModal/1 to show the dialog.

       getSelections(This) -> [integer()]

              Types:

                 This = wxMultiChoiceDialog()

              Returns array with indexes of selected items.

       setSelections(This, Selections) -> ok

              Types:

                 This = wxMultiChoiceDialog()
                 Selections = [integer()]

              Sets selected items from the array of selected items' indexes.

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

              Destroys the object.



wxWidgets team.                    wx 2.1.1             wxMultiChoiceDialog(3)