Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxSingleChoiceDialog (3erl)

Name

wxSingleChoiceDialog - Functions for wxSingleChoiceDialog class

Synopsis

Please see following description for synopsis

Description

wxSingleChoiceDialog(3)    Erlang Module Definition    wxSingleChoiceDialog(3)



NAME
       wxSingleChoiceDialog - Functions for wxSingleChoiceDialog class

DESCRIPTION
       This class represents a dialog that shows a list of strings, and allows
       the user to select one. Double-clicking on a list item is equivalent to
       single-clicking and then pressing OK.

       Styles

       This class supports the following styles:

       See: Overview cmndlg, wxMultiChoiceDialog

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

       wxWidgets docs: wxSingleChoiceDialog

DATA TYPES
       wxSingleChoiceDialog() = wx:wx_object()

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

              Types:

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

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

              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 and optional client data.

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

       getSelection(This) -> integer()

              Types:

                 This = wxSingleChoiceDialog()

              Returns the index of selected item.

       getStringSelection(This) -> unicode:charlist()

              Types:

                 This = wxSingleChoiceDialog()

              Returns the selected string.

       setSelection(This, Selection) -> ok

              Types:

                 This = wxSingleChoiceDialog()
                 Selection = integer()

              Sets the index of the initially selected item.

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

              Destroys the object.



wxWidgets team.                    wx 2.1.1            wxSingleChoiceDialog(3)