tbx  0.7.6
Public Types | Public Member Functions | List of all members
tbx::WritableField Class Reference

WritableField wrapper class for an underlying toolbox WritableField gadget. More...

#include <writablefield.h>

Inheritance diagram for tbx::WritableField:
tbx::Gadget tbx::Component

Public Types

enum  { TOOLBOX_CLASS = 512 }
 

Public Member Functions

 WritableField ()
 Construct an uninitialised display field.
 
 ~WritableField ()
 Destroy a Writable Field gadget. More...
 
 WritableField (const WritableField &other)
 Construct a writable field from another writableField. More...
 
 WritableField (const Gadget &other)
 Construct a writable field from another gadget. More...
 
 WritableField (const Component &other)
 Construct a writable field from a Component. More...
 
WritableFieldoperator= (const WritableField &other)
 Assign a writable field to refer to the same underlying toolbox gadget as another.
 
WritableFieldoperator= (const Gadget &other)
 Assign a writable field to refer to the same underlying toolbox gadget as an existing Gadget. More...
 
WritableFieldoperator= (const Component &other)
 Assign a writable field to refer to the same underlying toolbox component as an existing Gadget. More...
 
bool operator== (const Gadget &other) const
 Check if this display field refers to the same underlying toolbox gadget as another gadget. More...
 
bool operator!= (const Gadget &other) const
 Check if this display field refers to the same underlying toolbox gadget as another gadget. More...
 
void text (const std::string &value)
 Set the the text to display. More...
 
std::string text () const
 Get the the text that is being displayed.
 
int text_length () const
 Get the length of the text property. More...
 
void allowable (const std::string &value)
 
std::string allowable () const
 Get the pattern that specifies the character that can be entered into this field. More...
 
int allowable_length () const
 Get the length of the allowable pattern.
 
void font (const std::string &name, int width, int height)
 Set the font used for the writable field. More...
 
void system_font (int width, int height)
 Set the writable field to use the system font to display the text. More...
 
void add_text_changed_listener (TextChangedListener *listener)
 Add a listener to report when the text has changed in the writable field. More...
 
void remove_text_changed_listener (TextChangedListener *listener)
 Remove a text changed listener.
 
void add_key_listener (KeyListener *listener)
 Add a listener to report the keys pressed in a Writable field.
 
void remove_key_listener (KeyListener *listener)
 Remove the keys pressed event.
 
- Public Member Functions inherited from tbx::Gadget
 Gadget ()
 Construct an uninitialised gadget. More...
 
 Gadget (const Gadget &other)
 Construct a gadget as a copy of another gadget object. More...
 
 Gadget (const Component &other)
 Construct a gadget as a copy of another component object. More...
 
Window window ()
 Get the window that contains this gadget.
 
Window window () const
 Get the window that contains this gadget.
 
Gadgetoperator= (const Gadget &other)
 Assign this gadget to refer to the same underlying toolbox gadget as another gadget.
 
Gadgetoperator= (const Component &other)
 Assign this gadget to refer to the same underlying toolbox gadget as the specified Component. More...
 
bool operator== (const Component &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Component. More...
 
bool operator!= (const Component &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Component. More...
 
bool operator== (const Gadget &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Gadget. More...
 
bool operator!= (const Gadget &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Gadget. More...
 
void check_toolbox_class (int class_id) const
 Check the underlying gadget class for this object has the given class id. More...
 
int toolbox_class () const
 Get the toolbox class for a gadget. More...
 
int toolbox_class_and_size () const
 Get the toolbox class and size for a gadget. More...
 
unsigned int flags () const
 Return the gadget flags. More...
 
void set_flag (unsigned int set)
 Sets bits in the gadgets flags. More...
 
void clear_flag (unsigned int clear)
 Clear bits in the gadget flags. More...
 
void fade ()
 Fade the gadget.
 
void unfade ()
 Clear the gadgets fade state.
 
void fade (bool fade)
 Fade/unfade the gadget. More...
 
bool faded () const
 Check if the gadget is faded. More...
 
void focus ()
 Set input focus to the gadget. More...
 
std::vector< IconHandleicon_list ()
 Get list of icons used in this gadget. More...
 
BBox bounds () const
 Get the bounding box of the gadget.
 
void bounds (const BBox &bounds)
 Set the bounds of the gadget. More...
 
Point bottom_left () const
 Get the bottom left location of gadget. More...
 
Point top_left () const
 Get the top left location of gadget. More...
 
void move_to (const Point &pos)
 Move gadget (without resizing) More...
 
void move_to (int x, int y)
 Move gadget without resizing. More...
 
void move_by (int bx, int by)
 Move gadget relative to it's current position without resizing. More...
 
Size size () const
 Return the size of the gadget. More...
 
void size (const Size &sz)
 Set size of gadget without moving it. More...
 
void add_loader (Loader *loader, int file_type=-2)
 Add a file loader. More...
 
void remove_loader (Loader *loader, int file_type=-2)
 Remove a file loader. More...
 
- Public Member Functions inherited from tbx::Component
 Component ()
 Construct an uninitialised component. More...
 
 Component (Object obj, ComponentId id)
 Construct a component from an object and component id. More...
 
 Component (ObjectId handle, ComponentId id)
 Construct a component from an object handle and component id. More...
 
bool null () const
 Check if this component is in an uninitialised state. More...
 
Object object ()
 Return the object his component belongs to.
 
Object object () const
 Return the object his component belongs to.
 
ObjectId handle () const
 Return the object handle for his component.
 
ComponentId id () const
 Get the component ID of this component. More...
 
Componentoperator= (const Component &other)
 Assign the Component to refer to the same underlying toolbox component.
 
bool operator== (const Component &other) const
 Check if this component refers to the same underlying toolbox component. More...
 
bool operator!= (const Component &other) const
 Check if this component refers to the same underlying toolbox gadget. More...
 
 operator bool () const
 Operator to check if this component has been initialised. More...
 
void add_command (int command_id, Command *command)
 Add a command to this Component. More...
 
void remove_command (int command_id, Command *command)
 Remove a command from this component. More...
 
void add_user_event_listener (int event_id, UserEventListener *listener)
 Add a user event listener. More...
 
void remove_user_event_listener (int event_id, UserEventListener *listener)
 Remove a user event listener from this component. More...
 
void remove_all_listeners ()
 Remove all the listeners on this component. More...
 

Additional Inherited Members

- Protected Member Functions inherited from tbx::Component
void add_listener (int action, Listener *listener, RawToolboxEventHandler handler)
 Helper function to add listeners to this component. More...
 
void remove_listener (int action, Listener *listener)
 Helper function to remove listeners from this component.
 
void add_window_listener (int event_code, Listener *listener)
 Helper function to add a listener for a WIMP window event.
 
void remove_window_listener (int event_code, Listener *listener)
 Helper function to remove a listener for a WIMP window event.
 
int int_property (int property_id) const
 Get an integer property from the toolbox Component. More...
 
void int_property (int property_id, int value)
 Set an integer property from the toolbox object. More...
 
bool bool_property (int property_id) const
 Get a boolean property from the toolbox Component. More...
 
void bool_property (int property_id, bool value)
 Set a boolean property from the toolbox object. More...
 
std::string string_property (int property_id) const
 Get a string property from the toolbox object. More...
 
int string_property_length (int property_id) const
 Get a the length of a string property from the toolbox object. More...
 
void string_property (int property_id, const std::string &value)
 Set a string property in the toolbox object. More...
 
bool flag_property (int property_id, int flag) const
 Check if a particular flag is set in a property. More...
 
void flag_property (int property_id, int flag, bool value)
 Set a particular flag in a property. More...
 
- Protected Attributes inherited from tbx::Component
ObjectId _handle
 Underlying toolbox handle.
 
int _id
 Underlying toolbox component id.
 

Detailed Description

WritableField wrapper class for an underlying toolbox WritableField gadget.

A WritableField is a gadget that allows a line of text to be entered in a Window.

Constructor & Destructor Documentation

◆ ~WritableField()

tbx::WritableField::~WritableField ( )
inline

Destroy a Writable Field gadget.

This does not delete the underlying toolbox gadget.

◆ WritableField() [1/3]

tbx::WritableField::WritableField ( const WritableField other)
inline

Construct a writable field from another writableField.

Both WritableField will refer to the same underlying toolbox gadget.

◆ WritableField() [2/3]

tbx::WritableField::WritableField ( const Gadget other)
inline

Construct a writable field from another gadget.

The WritableField and the Gadget will refer to the same underlying toolbox gadget.

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a writable field

◆ WritableField() [3/3]

tbx::WritableField::WritableField ( const Component other)
inline

Construct a writable field from a Component.

Exceptions
ObjectClassErrorif the component is not in a window.
GadgetClassErrorif the underlying toolbox gadget isn't a writable field

Member Function Documentation

◆ add_text_changed_listener()

void tbx::WritableField::add_text_changed_listener ( TextChangedListener listener)

Add a listener to report when the text has changed in the writable field.

The writable field must have been set to deliver the default event for this listener to run.

◆ allowable() [1/2]

std::string tbx::WritableField::allowable ( ) const
inline

Get the pattern that specifies the character that can be entered into this field.

Returns
string specification of characters allowed to be entered or "" if no restriction.

◆ allowable() [2/2]

void tbx::WritableField::allowable ( const std::string &  value)
inline
Set the characters that are allowed to be entered into a writable field.

allow-spec ::= { char-spec }* { ~ { char-spec }* }*

char-spec ::= char | char-char char ::= - | \; | \ | | any character other than - ;

Each char-spec in the 'allow' string specifies a character or range
of characters; the ~ character toggles whether they are included or
excluded from the icon text string:

e.g. 0-9a-z~dpu   allows the digits 0 - 9 and the lower-case letters
a - z, except for 'd', 'p' and 'u'

If the first character following the A command is a ~ all normal
characters are initially included:

e.g. ~0-9   allows all characters except for the digits 0 - 9

If you use any of the four special characters - ; ~ \ in a char-spec
you must precede them with a backslash \:

e.g. ~\-\;\~\\ allows all characters except the four special ones
- ; ~ \

@param value string specifying what character can be entered into the list box.

◆ font()

void tbx::WritableField::font ( const std::string &  name,
int  width,
int  height 
)

Set the font used for the writable field.

Parameters
nameThe name of the font
widthfont width in 16ths of a point
heightfont height in 16ths of a point

◆ operator!=()

bool tbx::WritableField::operator!= ( const Gadget other) const
inline

Check if this display field refers to the same underlying toolbox gadget as another gadget.

Returns
true if they do not refer to the same underlying toolbox gadget.

◆ operator=() [1/2]

WritableField& tbx::WritableField::operator= ( const Component other)
inline

Assign a writable field to refer to the same underlying toolbox component as an existing Gadget.

Exceptions
ObjectClassErrorif the component is not in a window.
GadgetClassErrorif the underlying toolbox gadget isn't a writable field

◆ operator=() [2/2]

WritableField& tbx::WritableField::operator= ( const Gadget other)
inline

Assign a writable field to refer to the same underlying toolbox gadget as an existing Gadget.

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a display field

◆ operator==()

bool tbx::WritableField::operator== ( const Gadget other) const
inline

Check if this display field refers to the same underlying toolbox gadget as another gadget.

Returns
true if they refer to the same underlying toolbox gadget.

◆ system_font()

void tbx::WritableField::system_font ( int  width,
int  height 
)

Set the writable field to use the system font to display the text.

Parameters
widthfont width in 16ths of a point
heightfont height in 16ths of a point

◆ text()

void tbx::WritableField::text ( const std::string &  value)
inline

Set the the text to display.

Parameters
valuenew text to show in the writable field

◆ text_length()

int tbx::WritableField::text_length ( ) const
inline

Get the length of the text property.

Returns
Number of characters for this property

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