oracular (3) wxTextEntryDialog.3erl.gz

Provided by: erlang-manpages_25.3.2.12+dfsg-1ubuntu2_all bug

NAME

       wxTextEntryDialog - Functions for wxTextEntryDialog class

DESCRIPTION

       This class represents a dialog that requests a one-line text string from the user. It is implemented as a
       generic wxWidgets dialog.

       See: Overview cmndlg

       This class is derived (and can use functions) from: wxDialog wxTopLevelWindow wxWindow wxEvtHandler

       wxWidgets docs: wxTextEntryDialog

DATA TYPES

       wxTextEntryDialog() = wx:wx_object()

EXPORTS

       new() -> wxTextEntryDialog()

              Default constructor.

              Call Create() (not implemented in wx) to really create the dialog later.

              Since: 2.9.5

       new(Parent, Message) -> wxTextEntryDialog()

              Types:

                 Parent = wxWindow:wxWindow()
                 Message = unicode:chardata()

       new(Parent, Message, Options :: [Option]) -> wxTextEntryDialog()

              Types:

                 Parent = wxWindow:wxWindow()
                 Message = unicode:chardata()
                 Option =
                     {caption, unicode:chardata()} |
                     {value, unicode:chardata()} |
                     {style, integer()} |
                     {pos, {X :: integer(), Y :: integer()}}

              Constructor.

              Use wxDialog:showModal/1 to show the dialog.

              See Create() (not implemented in wx) method for parameter description.

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

              Destructor.

       getValue(This) -> unicode:charlist()

              Types:

                 This = wxTextEntryDialog()

              Returns the text that the user has entered if the user has pressed OK, or the  original  value  if
              the user has pressed Cancel.

       setValue(This, Value) -> ok

              Types:

                 This = wxTextEntryDialog()
                 Value = unicode:chardata()

              Sets the default text value.