Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxTextEntryDialog (3erl)

Name

wxTextEntryDialog - Functions for wxTextEntryDialog class

Synopsis

Please see following description for synopsis

Description

wxTextEntryDialog(3)       Erlang Module Definition       wxTextEntryDialog(3)



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  wxTo-
       pLevelWindow 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 dia-
              log 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  Can-
              cel.

       setValue(This, Value) -> ok

              Types:

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

              Sets the default text value.



wxWidgets team.                    wx 2.1.1               wxTextEntryDialog(3)