ubit::UButton Class Reference

Button widget. More...

#include <ubuttons.hpp>

Inheritance diagram for ubit::UButton:

List of all members.

Public Member Functions
	UButton (const UArgs &=UArgs::none)
	creates a button.
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!).

---

Detailed Description

Button widget.

Default Properties:

• same layout and resize behavior as ULabel.
• the font and foreground color are inherited from parents.
• the background color depends on parents. It is fully transparent if the prent is a UMenu, a UMenubar or a UBar and grey otherwise. The background can be made partially transparent by adding a UAlpha property.

Tool Tips:

• see the example below or class UTip.

Callback functions and methods:

• see the example below and class UCall.

Callback conditions:

• UOn::action : fires callbacks when the user clicks the button
• This is the default cllback condition : if no condition is given UOn::action is taken as the default
• UOn::arm : fires callbacks when the user arms the button
• UOn::disarm : fires callbacks when the user disarm the button
• see class UOn for other possible callback conditions.

Implicit callbacks for openening Menus and Dialogs:

• when a UMenu (resp. a UDialog) is a direct child of a UButton it is automatically opened when the button is pressed (resp. clicked)

See also:

• UItem : same behavior as UButton but with a different decoration which looks nicer than buttons when included in UListbox and UTrow widgets.

Exemple:

    void helpCB(const char* s) {...}  // non member function

    struct Demo {
        void saveFile() {...}   // member function (instance method)
        ....
    };

    Demo* d = new Demo;
    UBox& b = ubutton(UPix::diskette + " Save..."
                      + utip("Saves the current file")
                      + UOn::enter  / ucall("Saves the file", helpCB)
                      + UOn::action / ucall(d, &Demo::saveFile)
                      );
 

• utip("Saves the current file") adds a tool tip to this button

• UOn::enter / ucall("Saves the file", helpCB) specifies that helpCB("Saves the file") is called when the mouse pointer enters the button.

• UOn::action / ucall(d, &Demo::saveFile) specifies that d->saveFile() is called when the button is "activated" (for instance clicked).

See class UCall for further explanations and other examples.

---

Member Function Documentation

UStyle * ubit::UButton::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::UBox.

Reimplemented in ubit::UTabbutton, ubit::UFlatbutton, ubit::ULinkbutton, ubit::URadiobutton, and ubit::UCheckbox.

---

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

• ubuttons.hpp
• ubuttons.cpp

---