Maeomm Reference Documentation: hildonsmm |
When a captioned widget has focus, both the widget and the caption label are displayed with active focus.
Public Member Functions | ||||
Caption (const Glib::ustring& value, Gtk::Widget& child, CaptionStatus flag=CAPTION_OPTIONAL) | ||||
Caption (const Glib::ustring& value, Gtk::Widget& child, Gtk::Widget& icon, CaptionStatus flag=CAPTION_OPTIONAL) | ||||
Caption (const Glib::RefPtr<Gtk::SizeGroup>& group, const Glib::ustring& value, Gtk::Widget& child, Gtk::Widget& icon, CaptionStatus flag=CAPTION_OPTIONAL) | ||||
bool | get_child_expand () const | |||
Gets childs expandability. | ||||
const Gtk::Widget* | get_icon_image () const | |||
Gets icon of Hildon::Caption. | ||||
Gtk::Widget* | get_icon_image () | |||
Gets icon of Hildon::Caption. | ||||
CaptionIconPosition | get_icon_position () const | |||
Gets Hildon::Caption icon position. | ||||
Glib::ustring | get_label () const | |||
Gets label of Hildon::Caption. | ||||
float | get_label_alignment () const | |||
Gets current vertical alignment for the text part. | ||||
Glib::ustring | get_separator () const | |||
Gets separator string of Hildon::Caption. | ||||
Glib::RefPtr<const Gtk::SizeGroup> | get_size_group () const | |||
Query given captioned control for the Gtk::SizeGroup assigned to it. | ||||
Glib::RefPtr<Gtk::SizeGroup> | get_size_group () | |||
Query given captioned control for the Gtk::SizeGroup assigned to it. | ||||
CaptionStatus | get_status () const | |||
Gets Hildon::Caption status. | ||||
const HildonCaption* | gobj () const | |||
Provides access to the underlying C GtkObject. | ||||
HildonCaption* | gobj () | |||
Provides access to the underlying C GtkObject. | ||||
bool | is_mandatory () const | |||
Query Hildon::Caption whether this captioned control is a mandatory one. | ||||
void | set_child_expand (bool expand=true) | |||
Sets child expandability. | ||||
void | set_icon_image (Gtk::Widget& icon) | |||
Sets the icon image widget to be used by this hildon_caption widget. | ||||
void | set_icon_position (CaptionIconPosition pos) | |||
Sets Hildon::Caption icon position. | ||||
void | set_label (const Glib::ustring& label) | |||
Sets the label text that appears before the control. | ||||
void | set_label_alignment (float alignment) | |||
Sets the vertical alignment to be used for the text part of the caption. | ||||
void | set_label_markup (const Glib::ustring& markup) | |||
Sets the label markup text that appears before the control. | ||||
void | set_separator (const Glib::ustring& separator) | |||
Sets the separator character that appears after the label. | ||||
void | set_size_group (const Glib::RefPtr<Gtk::SizeGroup>& new_group) | |||
Sets a Gtk::SizeGroup of a given captioned control. | ||||
void | set_status (CaptionStatus flag) | |||
Sets Hildon::Caption status. | ||||
Glib::SignalProxy0<void> | signal_activate () | |||
| ||||
virtual | ~Caption () | |||
Related Functions | ||||
(Note that these are not member functions.) | ||||
Hildon::Caption* | wrap (HildonCaption* object, bool take_copy=false) | |||
|
virtual Hildon::Caption::~Caption | ( | ) | [virtual] |
Hildon::Caption::Caption | ( | const Glib::RefPtr< Gtk::SizeGroup > & | group, | |
const Glib::ustring & | value, | |||
Gtk::Widget & | child, | |||
Gtk::Widget & | icon, | |||
CaptionStatus | flag = CAPTION_OPTIONAL | |||
) |
Hildon::Caption::Caption | ( | const Glib::ustring & | value, | |
Gtk::Widget & | child, | |||
Gtk::Widget & | icon, | |||
CaptionStatus | flag = CAPTION_OPTIONAL | |||
) |
Hildon::Caption::Caption | ( | const Glib::ustring & | value, | |
Gtk::Widget & | child, | |||
CaptionStatus | flag = CAPTION_OPTIONAL | |||
) |
bool Hildon::Caption::get_child_expand | ( | ) | const |
Gets childs expandability.
Returns : wheter the child is expandable or not.
const Gtk::Widget* Hildon::Caption::get_icon_image | ( | ) | const |
Gets icon of Hildon::Caption.
Returns : the Gtk::Image widget that is being used as the icon by the hildon_caption, or 0
if no icon image is in use.
Gtk::Widget* Hildon::Caption::get_icon_image | ( | ) |
Gets icon of Hildon::Caption.
Returns : the Gtk::Image widget that is being used as the icon by the hildon_caption, or 0
if no icon image is in use.
CaptionIconPosition Hildon::Caption::get_icon_position | ( | ) | const |
Gets Hildon::Caption icon position.
Returns : one of the values from Hildon::CaptionIconPosition.
Glib::ustring Hildon::Caption::get_label | ( | ) | const |
Gets label of Hildon::Caption.
Returns : the text currently being used as the label of the caption control.
float Hildon::Caption::get_label_alignment | ( | ) | const |
Gets current vertical alignment for the text part.
Glib::ustring Hildon::Caption::get_separator | ( | ) | const |
Gets separator string of Hildon::Caption.
Returns : the text currently being used as the separator of the caption control.
Glib::RefPtr<const Gtk::SizeGroup> Hildon::Caption::get_size_group | ( | ) | const |
Query given captioned control for the Gtk::SizeGroup assigned to it.
Returns : a Gtk::SizeGroup
Glib::RefPtr<Gtk::SizeGroup> Hildon::Caption::get_size_group | ( | ) |
Query given captioned control for the Gtk::SizeGroup assigned to it.
Returns : a Gtk::SizeGroup
CaptionStatus Hildon::Caption::get_status | ( | ) | const |
Gets Hildon::Caption status.
Returns : one of the values from Hildon::CaptionStatus
const HildonCaption* Hildon::Caption::gobj | ( | ) | const [inline] |
HildonCaption* Hildon::Caption::gobj | ( | ) | [inline] |
bool Hildon::Caption::is_mandatory | ( | ) | const |
Query Hildon::Caption whether this captioned control is a mandatory one.
Returns : is this captioned control a mandatory one?
void Hildon::Caption::set_child_expand | ( | bool | expand = true |
) |
Sets child expandability.
expand | bool to determine if the child is expandable. |
void Hildon::Caption::set_icon_image | ( | Gtk::Widget & | icon | ) |
Sets the icon image widget to be used by this hildon_caption widget.
icon | The Gtk::Image to use as the icon. calls gtk_widget_show on the icon if !GTK_WIDGET_VISIBLE(icon). |
void Hildon::Caption::set_icon_position | ( | CaptionIconPosition | pos | ) |
Sets Hildon::Caption icon position.
pos | One of the values from Hildon::CaptionIconPosition. |
void Hildon::Caption::set_label | ( | const Glib::ustring & | label | ) |
Sets the label text that appears before the control.
Separator character is added to the end of the label string. By default the separator is ":".
label | The text to use. |
void Hildon::Caption::set_label_alignment | ( | float | alignment | ) |
Sets the vertical alignment to be used for the text part of the caption.
Applications need to align the child control themselves.
alignment | New vertical alignment. |
void Hildon::Caption::set_label_markup | ( | const Glib::ustring & | markup | ) |
Sets the label markup text that appears before the control.
It acts like hildon_caption_set_label but is using the markup text that allows to specify text properties such as bold or italic.
markup | The markup text to use. |
void Hildon::Caption::set_separator | ( | const Glib::ustring & | separator | ) |
Sets the separator character that appears after the label.
The default seaparator character is ":" separately.
separator | The separator to use. |
void Hildon::Caption::set_size_group | ( | const Glib::RefPtr< Gtk::SizeGroup > & | new_group | ) |
void Hildon::Caption::set_status | ( | CaptionStatus | flag | ) |
Glib::SignalProxy0< void > Hildon::Caption::signal_activate | ( | ) |
void activate()
Hildon::Caption* wrap | ( | HildonCaption * | object, | |
bool | take_copy = false | |||
) | [related] |
object | The C instance |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |