ubit
Public Member Functions | Static Public Member Functions | List of all members
ubit::UTextarea Class Reference

Textarea widget: multiple line editor. More...

#include <uinteractors.hpp>

Inheritance diagram for ubit::UTextarea:
ubit::UTextfield ubit::UBox ubit::UElem ubit::UNode ubit::UObject

Public Member Functions

 UTextarea (UArgs arglist=UArgs::none)
 creates a new text area ( More...
 
- Public Member Functions inherited from ubit::UTextfield
 UTextfield (UArgs arglist=UArgs::none)
 creates a widget for editing a line of text ( More...
 
 UTextfield (int nbchars, UArgs arglist=UArgs::none)
 creates a widget for editing one line of text ( More...
 
virtual bool isEditable () const
 
virtual UTextfieldsetEditable (bool state=true)
 
UEditedit ()
 returns the UEdit attribute that controls the edition of the textfield.
 
- Public Member Functions inherited from ubit::UBox
 UBox (UArgs args=UArgs::none)
 creates a new UBox; The argument can either be a single object pointer or reference, or a list of object pointers or references separated by + operators, example: More...
 
virtual ~UBox ()
 recursive destructor. More...
 
virtual UBoxtoBox ()
 dynamic cast: returns this object if it derives from UBox and null otherwise.
 
virtual const UBoxtoBox () const
 dynamic cast: returns this object if it derives from UBox and null otherwise.
 
virtual int getDisplayType () const
 
void repaint ()
 
void update ()
 updates object graphics.
 
virtual void update (const UUpdate &update_options, UDisp *=null)
 indicates that the layout and/or the paint of this object will be updated. More...
 
virtual void doUpdate (const UUpdate &, UDisp *=null)
 updates the layout and/or the paint of this object right now. More...
 
virtual int getViewCount () const
 returns the number of views of this box.
 
virtual int getViews (std::vector< UView *> &) const
 returns the views of this box (see DETAILS). More...
 
virtual UViewgetView (int n=0) const
 returns the Nth view of this box (see DETAILS). More...
 
virtual UViewgetView (const UInputEvent &) const
 returns the view of this box that contains the event location.
 
virtual UViewgetView (UWin &, const UPoint &pos_in_win, UDisp *=null) const
 returns the view of this box that contains this point in this window.
 
virtual UViewgetViewContaining (const UView &child_view) const
 returns the view of this box that contains 'child_view'. More...
 
virtual UViewgetFirstViewInside (const UView &parent_view) const
 returns the first box view that is contained in 'parent_view'. More...
 
virtual int retrieveRelatedViews (std::vector< UView *> &collating_vector) const
 
virtual UViewgetViewInImpl (UView *parent_view)
 
virtual UViewgetViewInImpl (UView *parent_view, UDimension &)
 
void setViewModes (int view_modes, bool)
 
- Public Member Functions inherited from ubit::UElem
 UElem (UArgs node_arglist=UArgs::none)
 creates a new UElem; The argument can either be a single object pointer or reference, or a list of object pointers or references separated by + operators, example: More...
 
virtual ~UElem ()
 destructor, note that children are recursively destroyed except if pointed elsewhere ( More...
 
virtual void destructs ()
 unlinks the object from its parents and destroys its children.
 
virtual UElemtoElem ()
 dynamic cast: returns this object if it derives from UElem and null otherwise.
 
virtual const UElemtoElem () const
 dynamic cast: returns this object if it derives from UElem and null otherwise.
 
const UStylegetStyle (UUpdateContext *) const
 virtual function that returns the style of this object. More...
 
virtual int getNodeType () const
 returns the XML node type.
 
virtual const UStrgetNodeName () const
 return the XML node name (which is the class name).
 
virtual void initNode (UDoc *context)
 initialises the XML context of this node.
 
UElemsetAttr (UNode &attribute)
 adds or replaces this attribute in the ATTRIBUTE list. More...
 
UElemaddAttr (const UArgs &attributes)
 adds one or several attributes (deriving from UAttr) to the ATTRIBUTE list. More...
 
UElemremoveAttr (UNode &attribute, bool auto_delete=true)
 removes/deletes an attribute (and its descendants) from the ATTRIBUTE list. More...
 
UElemremoveAllAttrs (bool auto_delete=true)
 removes/deletes all attributes (and their descendants) in the ATTRIBUTE list. More...
 
bool getAttrValue (UStr &value, const UStr &attr_name) const
 retrieves the value of the attribute which class name is 'attr_name'. More...
 
UAttrgetAttr (const UStr &attr_name) const
 returns the attribute node which class name is 'attr_name'. More...
 
template<class ATTR >
ATTR * getAttr () const
 retrieves the attribute node that derives from the "ATTR" C++ class. More...
 
template<class ATTR >
ATTR & obtainAttr ()
 retrieves or creates the element's attribute that derives from the "ATTR" C++ class. More...
 
virtual bool isParentOf (const UNode &possible_child) const
 returns true if this object a direct or indirect parent of 'child'.
 
UElemadd (const UArgs &children)
 adds one or several objects to the end of the CHILD list of this element. More...
 
UElemadd (const UArgs &children, int position)
 adds one or several objects in the CHILD list before this position. More...
 
UElemadd (const UArgs &children, UChildIter iterator)
 adds one or several objects in the CHILD list before this iterator. More...
 
virtual UElemaddImpl (const UArgs &nodes, UChildIter pos, UChildren &in_list)
 
virtual bool addImpl1 (const UChild &node, UChildIter pos, UChildren &in_list)
 
UElemremove (UNode &child, bool auto_delete=true)
 removes/deletes a child (and its descendants) from the CHILD list. More...
 
UElemremove (int pos, bool auto_delete=true)
 removes/deletes a child (and its descendants) at this position in the CHILD list. More...
 
UElemremove (UChildIter pos, bool auto_delete=true)
 removes/deletes a child (and its descendants) at this position in the CHILD list. More...
 
UElemremoveAll (bool auto_delete=true)
 removes/deletes all children (and their descendants) in the CHILD list. More...
 
virtual UElemremoveImpl (UChildIter begin, int N, bool autodel, UChildren &in_list)
 
virtual bool removeImpl1 (UChildIter pos, int auto_delete, UChildren &in_list)
 
UChildrengetChildren () const
 
int getChildCount () const
 
UChildIter child (int pos) const
 
UNodegetChild (int pos) const
 returns an iterator pointing to the child at this position. More...
 
UChildIter cbegin () const
 returns the child at this position. More...
 
UChildIter cend () const
 returns a forward iterator pointing to the end of the child list ( More...
 
UChildReverseIter crbegin () const
 returns a reverse iterator pointing to the beginning of the child list ( More...
 
UChildReverseIter crend () const
 returns a reverse iterator pionting to the end of the child list ( More...
 
virtual UStr retrieveText (bool recursive=true) const
 collates and returns the text that is enclosed in this object. More...
 
virtual void retrieveText (UStr &string, bool recursive=true) const
 collates and returns the text that is enclosed in this object. More...
 
virtual bool isShown () const
 returns true if this object is shown. More...
 
bool isShowable () const
 returns true if this object can be shown. More...
 
void setShowable (bool s) const
 synonym for show(bool).
 
virtual void show (bool=true)
 shows/hides this object. More...
 
void repaint ()
 indicates that this object will be repainted (when the main loop becomes idle).
 
void update ()
 indicates that this object will be layed out and repainted (when the main loop becomes idle).
 
void doUpdate ()
 
UElemignoreEvents (bool state=true)
 if arg is true, this element and (its children) ignore events. More...
 
UElemcatchEvents (const UChild &condition_callback_expr)
 catches certain events before they reach the object's children. More...
 
UElemobserveChildrenEvents (const UChild &condition_callback_expr)
 observe events that occur in children. More...
 
bool isIgnoringEvents () const
 returns true if events are ignored by this object;
 
bool hasCallback (long callback_id) const
 true if thie object has such a callback.
 
virtual bool fire (UEvent &) const
 fires callback functions that match this event.
 
UElemenable (bool state=true)
 shortcut for setEnabled(bool state = true).
 
virtual UElemsetEnabled (bool state=true, bool call_callbacks=true)
 specifies whether this object is enabled. More...
 
bool isEnabled () const
 returns true if this object is currently enabled; More...
 
virtual UElemsetSelected (bool state=true, bool call_callbacks=true)
 specifies whether this object is selected. More...
 
bool isSelected () const
 
bool isSelectable () const
 
UElemsetSelectable (bool state=true)
 
bool isArmed () const
 
bool isArmable () const
 specifies whether this object can be armed. More...
 
UElemsetArmable (bool state=true)
 
UElemsetAutoRepeat (bool state=true)
 
bool isAutoRepeat () const
 
bool isCrossable () const
 
UElemsetCrossable (bool state=true)
 
UElemsetBrowsable (bool=true)
 
bool isBrowsable () const
 
bool isDragged () const
 
bool isDraggable () const
 
UElemsetDraggable (bool=true)
 
bool isDroppable () const
 
UElemsetDroppable (bool=true)
 
bool isTextEditable () const
 
bool isFloating () const
 
bool isVertical () const
 
bool isWidthResizable () const
 
bool isHeightResizable () const
 
virtual bool isSubWin () const
 
void disableMenuClosing (bool s=true)
 this object and its children wont close menus when clicked if argument is true.
 
bool isMenuClosingDisabled () const
 true if this object and its children do not close menus when clicked.
 
bool isBrowsingGroup ()
 
virtual UChildrenchildren () const
 
virtual UChildrenattributes () const
 
UChildIter abegin () const
 
UChildIter aend () const
 
UObject::State getInterState () const
 
void setInterState (UObject::State)
 
virtual const UStrgetTextSeparator () const
 returns the text separator used by retrieveText() for separating enclosed children
 
virtual void highlight (bool state)
 
UElem_setArmableAndSelectable (bool state)
 
virtual void keyPressBehavior (UKeyEvent &)
 
virtual void keyReleaseBehavior (UKeyEvent &)
 
virtual void enterBehavior (UInputEvent &, bool is_browing)
 
virtual void leaveBehavior (UInputEvent &, bool is_browing)
 
virtual void armBehavior (UInputEvent &, bool is_browing)
 
virtual void disarmBehavior (UInputEvent &, bool is_browing)
 
virtual void actionBehavior (UInputEvent &)
 
- Public Member Functions inherited from ubit::UNode
virtual UStr getNodeValue () const
 return the XML node value.
 
virtual int isDisplayable () const
 
virtual UNodetoNode ()
 dynamic cast: returns this object if it derives from UNode and null otherwise.
 
virtual const UNodetoNode () const
 dynamic cast: returns this object if it derives from UNode and null otherwise.
 
virtual bool isChildOf (const UElem &parent, bool indirect=true) const
 returns true if this object a child of 'parent'. More...
 
UParentIter pbegin () const
 returns an iterator to the beginning of the list of direct parents. More...
 
UParentIter pend () const
 returns an iterator to the end of the parent list ( More...
 
virtual UParentsparents () const
 returns the list of direct parents ( More...
 
virtual UElemgetParent (int pos=0) const
 returns the Nth direct parent. More...
 
virtual bool hasSceneGraphParent () const
 
template<class CC >
CC * findParent () const
 < this object has at least one parent in the scene graph. More...
 
virtual int getBoxParents (std::vector< UBox *> &parvect) const
 retrieves direct and indirect parents that are boxes.
 
virtual UBoxgetParent (const UView *) const
 returns the direct or indirect parent that contains this view. More...
 
virtual UViewgetParentView (const UView *) const
 returns the direct or indirect parent's view that contains this view. More...
 
virtual UBoxgetParent (const UInputEvent &) const
 
virtual UViewgetParentView (const UInputEvent &) const
 
virtual void removeFromParents (bool update_parents=true)
 [impl] removes this object from all direct parents. More...
 
bool isAutoUpdate () const
 return current update policy: see setAutoUpdate().
 
UNodesetAutoUpdate (bool state=true)
 changes the update policy of this object when its is modified. More...
 
void fireParents (const UCond &c, UNode *n) const
 
void updateAutoParents (const UUpdate &m)
 
virtual void addChangeCall (UCall &)
 
virtual UElemgetSubGroup () const
 
void _addAttr (const UChild &attribute)
 [impl] to be removed @.
 
UChildIter _abegin () const
 [impl] to be removed @.
 
UChildIter _aend () const
 [impl] to be removed @.
 
- Public Member Functions inherited from ubit::UObject
 UObject (const UObject &)
 
UObjectoperator= (const UObject &)
 
virtual const UClassgetClass () const
 instance method that returns the metaclass of this object. More...
 
const UStrgetClassName () const
 returns getClass().getName().
 
virtual void error (const char *function_name, const char *format,...) const
 prints out an error message. More...
 
virtual void warning (const char *function_name, const char *format,...) const
 prints out a warning message: More...
 
bool isDeletable () const
 checks if this object can be destroyed by 'delete'. More...
 
bool isConst () const
 checks whether the content of this object can be modified ( More...
 
UObjectsetConst ()
 specifies that the content of this object cannot be modified. More...
 
bool isAutoUpdate () const
 return current update policy: More...
 
UObjectsetAutoUpdate (bool state=true)
 changes the update policy of this object when its is modified. More...
 
bool isIgnoringChangeCallbacks () const
 return true if change callbacks are fired.
 
UObjectignoreChangeCallbacks (bool state)
 change callbacks are not fired if argument is true.
 
virtual UAttrtoAttr ()
 dynamic cast: returns this object if it derives from UAttr and null otherwise.
 
virtual const UAttrtoAttr () const
 dynamic cast: returns this object if it derives from UAttr and null otherwise.
 
virtual UDatatoData ()
 dynamic cast: returns this object if it derives from UData and null otherwise.
 
virtual const UDatatoData () const
 dynamic cast: returns this object if it derives from UData and null otherwise.
 
virtual UStrtoStr ()
 dynamic cast: returns this object if it derives from UStr and null otherwise.
 
virtual const UStrtoStr () const
 dynamic cast: returns this object if it derives from UStr and null otherwise.
 
virtual UCalltoCall ()
 dynamic cast: returns this object if it derives from UCall and null otherwise.
 
virtual const UCalltoCall () const
 dynamic cast: returns this object if it derives from UCall and null otherwise.
 
virtual UWintoWin ()
 dynamic cast: returns this object if it derives from UWin and null otherwise.
 
virtual const UWintoWin () const
 dynamic cast: returns this object if it derives from UWin and null otherwise.
 
virtual UMenutoMenu ()
 dynamic cast: returns this object if it derives from UMenu and null otherwise.
 
virtual const UMenutoMenu () const
 dynamic cast: returns this object if it derives from UMenu and null otherwise.
 
State getState () const
 returns the current object state.
 
void setState (State s)
 changes the object state.
 
PtrCount getPtrCount () const
 [impl] returns the number of uptr<> smart pointers that are pointing to this object.
 
bool checkConst () const
 [impl] produces an error if this object is logically constant ( More...
 
bool isDestructed () const
 [impl] this object has been destructed (but memory has not been freed yet).
 
bool isDestructing () const
 [impl] this object is being destructed (one of its destructors has been called).
 
void * operator new (size_t)
 < [impl] returns true if there is at least one scene graph parent (redefined by UNode). More...
 
void operator delete (void *)
 delete operator is forbidden on instances that derive from UObject.
 
void addPtr () const
 [Impl] a uptr is added to this object.
 
void removePtr () const
 [Impl] a uptr is removed from this object.
 

Static Public Member Functions

static UStylecreateStyle ()
 
- Static Public Member Functions inherited from ubit::UTextfield
static UStylecreateStyle ()
 
- Static Public Member Functions inherited from ubit::UBox
static UStylecreateStyle ()
 static function that returns the style of this class (see details!). More...
 
- Static Public Member Functions inherited from ubit::UElem
static UStylecreateStyle ()
 static function that returns the style of this class. More...
 
static void closeWin (UInputEvent &, int status)
 closes the first window (UDialog, UMenu...) that contains this element. More...
 
- Static Public Member Functions inherited from ubit::UObject
static const char * getVersion ()
 returns the version of the Ubit package.
 
static const UClassClass ()
 class method that returns the metaclass of this class. More...
 
static UStylecreateStyle ()
 

Additional Inherited Members

- Public Types inherited from ubit::UElem
enum  { REMOVE_FROM_PARENTS = -1 }
 
- Public Types inherited from ubit::UNode
enum  NodeType {
  ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4,
  ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8,
  DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12
}
 redefines Class() and getClass() methods ( More...
 
enum  DisplayType {
  WINLIST =-1, UNDISPLAYBLE =0, ATTRIBUTE, DATA,
  INLINE, BLOCK, BORDER, HARDWIN,
  SOFTWIN
}
 Ubit display types.
 
- Public Types inherited from ubit::UObject
typedef unsigned char State
 
typedef short PtrCount
 
- Static Public Attributes inherited from ubit::UObject
static UConst UCONST
 UCONST can be given as an argument to some constructors to make the object constant. More...
 
- Protected Member Functions inherited from ubit::UBox
virtual void addViewImpl (UView *)
 
virtual void initView (UView *parent_view)
 
virtual void initChildViews (UElem *)
 
virtual void deleteViewsInside (const std::vector< UView *> &parent_views)
 
- Protected Member Functions inherited from ubit::UElem
virtual int _getTextLength (bool recursive) const
 
virtual char * _getTextData (char *ptr, bool recursive) const
 
- Protected Member Functions inherited from ubit::UNode
 UNode ()
 constructor, can anly be called by subclasses because UNode is abstract.
 
virtual ~UNode ()
 destructor, note that children are recursively destroyed except if pointed elsewhere ( More...
 
virtual void addingTo (UChild &, UElem &parent)
 called when this object is added to a parent.
 
virtual void removingFrom (UChild &, UElem &parent)
 called when this object is removed from a parent (SEE DETAILS IF YOU REDEFINE THIS METHOD). More...
 
- Protected Attributes inherited from ubit::UBox
UViewviews
 
- Protected Attributes inherited from ubit::UElem
Modes emodes
 
long callback_mask
 
UChildren _children
 
- Protected Attributes inherited from ubit::UNode
UParents _parents
 
UChildren _attributes
 
- Protected Attributes inherited from ubit::UObject
PtrCount ptr_count
 
Modes omodes
 
State ostate
 

Detailed Description

Textarea widget: multiple line editor.

This widget does the same as UTextfield except that is can contains as many lines as needed. Children are layed out as a continuous flow: see UFlowView.

Constructor & Destructor Documentation

§ UTextarea()

ubit::UTextarea::UTextarea ( UArgs  arglist = UArgs::none)
inline

creates a new text area (

See also
also shortcut utextarea()).

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