ubit::UTextfield Class Reference

Textfield widget: single line editor. More...

#include <utextbox.hpp>

Inheritance diagram for ubit::UTextfield:

List of all members.

Public Member Functions
	UTextfield (const UArgs &=UArgs::none)
virtual bool	isEditable () const
virtual UTextfield &	setEditable (bool state=true)
UEdit &	edit ()
const UEdit &	edit () const
Static Public Member Functions
static UStyle *	createStyle ()
	< important: all subclasses MUST contain this declaration. static function that returns the UStyle of this class (see details!).
Protected Attributes
uptr< UEdit >	pedit
Friends
UTextfield &	utextfield (const UArgs &a=UArgs::none)
	creates a widget for editing a line of text.

---

Detailed Description

Textfield widget: single line editor.

UTextfield has the same default properties and layout as UTextbox except that the UStr(ings) contained in a UTextfield are editable and that its background color is white.

A UTextfield can contain a combination of UStr(ings) and other objects (for instance UIma(ges), ULinkbutton(s), etc.). This makes it possible to create hypertext in a simple way. All strings are then editable.

      UStr& s = ustr("World!");
      utextfield( UPix::doc + "Hello " + UPix::ray + s )
  

Callback conditions:

• UOn::action : fires callbacks when the RETURN key is pressed. This is the default callback (ie. UOn::action can be omitted)
• UOn::strChange fires callbacks when the text is changed
• for other possible callback conditions, see class UOn.

Example:

      struct Demo {
         void enterCB(UStr* s);           // instance method
         static void changeCB(UStr* s);   // static function
      };

      Demo* d = new Demo;
      UStr* s = &ustr("Hello World!");
      utextfield(UPix::ray + s
                 + UOn::action    / ucall(d, s, &Demo::enterCB)
                 + UOn::strChange / ucall(s, changeCB));
 

• d->enterCB(s) is called when the RETURN key is pressed.
• changeCB(s) is called when the content of the string is changed Note that 'd' is given as the first argument of ucall(d, s, &Demo::enterCB) because enterCB() is an instance method of Demo.

The next example shows another method to retreive the text that is included in a UTextfield (instead of passing 's' as an arg to the callback function):

      struct Demo {
         void keyCB(UEvent&);
      };

      Demo* d = new Demo;
      utextfield(UPix::ray + "Hello World!"
                 + UOn::ktype / ucall(d, &Demo::keyCB));

      void Demo::keyCB(UEvent& e) {
         if (!e.getSource()) return;
         UStr s = e.getSource()->retrieveText();
         char c = e.getChar();
         ...
    }
 

• e.getSource() returns a pointer to the UTextfield
• retrieveText() returns the text that is contained in the UTextfield All callback methods and functions can have an optional UEvent argument

Other remarks:

• if a widget contains several strings, retrieveText() collates the text of all of them
• the UTextbox could be an instance variable of Demo, in which case it could be direclty referenced in the callback function (instead of calling e.getSource() to retreive it)
• instance methods can have 0 to 2 args and static functions 1 to 2 args (in addition to the optionnal UEvent arg). See UCall for more details.

Implementation note:

• a textfield is a UTextbox that can contains a (hidden) UEdit instance: utextfield("Hello World") == utextbox(uedit() + "Hello World");

---

Member Function Documentation

UStyle * ubit::UTextfield::createStyle

(

)

[static]

< important: all subclasses MUST contain this declaration. static function that returns the UStyle of this class (see details!).

this macro defines the UClass that corresponds to this class and:

• classid() : a static function that returns this UClass
• getClass() : a virtual function that returns this UClass

  See also:

  : class UClass, macro UBIT_ELEMENT_CLASS(). this function MUST be redefined by subclasses that use another UStyle.

Reimplemented from ubit::UTextbox.

Reimplemented in ubit::UCombobox, and ubit::UTextarea.

---

The documentation for this class was generated from the following files:

• utextbox.hpp
• utextbox.cpp

---