Hildon::Caption Class Reference
[Widgets]

Hildon::Caption is a single-child container widget that precedes the contained widget with a field label and an optional icon, allowing grouping of several controls together. More...

Inheritance diagram for Hildon::Caption:

[legend]

List of all members.

Public Member Functions

virtual ~Caption ()

HildonCaption* gobj ()

Provides access to the underlying C GtkObject.

const HildonCaption* gobj () const

Provides access to the underlying C GtkObject.

Caption (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)

Caption (const Glib::ustring& value, Gtk::Widget& child, Gtk::Widget& icon, CaptionStatus flag=CAPTION_OPTIONAL)

Caption (const Glib::ustring& value, Gtk::Widget& child, CaptionStatus flag=CAPTION_OPTIONAL)

Glib::RefPtr<Gtk::SizeGroup> get_size_group ()

Queries given captioned control for the Gtk::SizeGroup assigned to it.

Glib::RefPtr< const
Gtk::SizeGroup > get_size_group () const

Queries given captioned control for the Gtk::SizeGroup assigned to it.

void set_size_group (const Glib::RefPtr<Gtk::SizeGroup>& new_group)

Sets a Gtk::SizeGroup of a given captioned control.

bool is_mandatory () const

Queries whether caption is mandatory.

void set_status (CaptionStatus flag)

Sets caption's status.

CaptionStatus get_status () const

Gets caption's status.

void set_icon_position (CaptionIconPosition pos)

Sets caption's icon position.

CaptionIconPosition get_icon_position () const

Gets caption's icon position.

void set_icon_image (Gtk::Widget& icon)

Sets the icon image widget to be used by caption.

Gtk::Widget* get_icon_image ()

Gets the icon image widget used by caption.

const Gtk::Widget* get_icon_image () const

Gets the icon image widget used by caption.

void set_label (const Glib::ustring& label)

Sets the label text that appears before the control.

Glib::ustring get_label () const

Gets the label of the Hildon::Caption.

void set_separator (const Glib::ustring& separator)

Sets the separator character that appears after the label.

Glib::ustring get_separator () const

Gets the separator string of the Hildon::Caption.

void set_label_alignment (float alignment)

Sets the vertical alignment to be used for the text part of the caption.

float get_label_alignment () const

Gets current vertical alignment for the text part.

void set_child_expand (bool expand=true)

Sets child expandability.

bool get_child_expand () const

Gets childs expandability.

void set_label_markup (const Glib::ustring& markup)

Sets the label markup text that appears before the control.

Glib::SignalProxy0<void> signal_activate ()

Related Functions

(Note that these are not member functions.)

Hildon::Caption* wrap (HildonCaption* object, bool take_copy=false)

A Glib::wrap() method for this object.

Detailed Description

Hildon::Caption is a single-child container widget that precedes the contained widget with a field label and an optional icon, allowing grouping of several controls together.

When a captioned widget has focus, both the widget and the caption label are displayed with active focus.

Constructor & Destructor Documentation

virtual Hildon::Caption::~Caption ( ) [virtual]

Hildon::Caption::Caption ( CaptionStatus flag = CAPTION_OPTIONAL ) [explicit]

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`
	)

Member Function Documentation

HildonCaption* Hildon::Caption::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::EventBox.

const HildonCaption* Hildon::Caption::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::EventBox.

Glib::RefPtr<Gtk::SizeGroup> Hildon::Caption::get_size_group ( )

Queries given captioned control for the Gtk::SizeGroup assigned to it.

Returns:: A Gtk::SizeGroup.

Glib::RefPtr<const Gtk::SizeGroup> Hildon::Caption::get_size_group ( ) const

Queries given captioned control for the Gtk::SizeGroup assigned to it.

Returns:: A Gtk::SizeGroup.

void Hildon::Caption::set_size_group ( const Glib::RefPtr< Gtk::SizeGroup > & new_group )

Sets a Gtk::SizeGroup of a given captioned control.

Parameters:

new_group

A Gtk::SizeGroup.

bool Hildon::Caption::is_mandatory ( ) const

Queries whether caption is mandatory.

Returns:: Whether this captioned control is mandatory.

void Hildon::Caption::set_status ( CaptionStatus flag )

Sets caption's status.

Parameters:

flag

One of the values from Hildon::CaptionStatus.

CaptionStatus Hildon::Caption::get_status ( ) const

Gets caption's status.

Returns:: One of the values from Hildon::CaptionStatus.

void Hildon::Caption::set_icon_position ( CaptionIconPosition pos )

Sets caption's icon position.

Parameters:

pos

One of the values from Hildon::CaptionIconPosition.

CaptionIconPosition Hildon::Caption::get_icon_position ( ) const

Gets caption's icon position.

Returns:: One of the values from Hildon::CaptionIconPosition.

void Hildon::Caption::set_icon_image ( Gtk::Widget & icon )

Sets the icon image widget to be used by caption.

Parameters:

icon

The Gtk::Image to use as the icon. Calls gtk_widget_show() on the icon if it is not visible.

Gtk::Widget* Hildon::Caption::get_icon_image ( )

Gets the icon image widget used by caption.

Returns:: The Gtk::Image widget that is being used as the icon by caption, or 0 if no icon image is in use.

const Gtk::Widget* Hildon::Caption::get_icon_image ( ) const

Gets the icon image widget used by caption.

Returns:: The Gtk::Image widget that is being used as the icon by caption, or 0 if no icon image is in use.

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 ":". See also set_separator().

Parameters:

label

The text to use.

Glib::ustring Hildon::Caption::get_label ( ) const

Gets the label of the Hildon::Caption.

Returns:: The text currently being used as the label of the caption control.

void Hildon::Caption::set_separator ( const Glib::ustring & separator )

Sets the separator character that appears after the label.

The default seaparator character is ":".

Parameters:

separator

The separator to use.

Glib::ustring Hildon::Caption::get_separator ( ) const

Gets the separator string of the Hildon::Caption.

Returns:: The text currently being used as the separator of the caption control.

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.

Parameters:

alignment

New vertical alignment.

float Hildon::Caption::get_label_alignment ( ) const

Gets current vertical alignment for the text part.

Returns:: Vertical alignment.

void Hildon::Caption::set_child_expand ( bool expand = true )

Sets child expandability.

Parameters:

expand

Whether the child is expandable.

bool Hildon::Caption::get_child_expand ( ) const

Gets childs expandability.

Returns:: Wheter the child is expandable or not.

void Hildon::Caption::set_label_markup ( const Glib::ustring & markup )

Sets the label markup text that appears before the control.

It acts like set_label() but is using the markup text that allows to specify text properties such as bold or italic.

Parameters:

markup

The markup text to use.

Glib::SignalProxy0< void > Hildon::Caption::signal_activate ( )

Prototype:: void on_my_activate()

Friends And Related Function Documentation

Hildon::Caption* wrap	(	HildonCaption *	object,
		bool	take_copy = `false`
	)			`[related]`

A Glib::wrap() method for this object.

Parameters:

	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.

Returns:: A C++ instance that wraps this C instance.

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

caption.h


Public Member Functions
virtual	~Caption ()
HildonCaption*	gobj ()
	Provides access to the underlying C GtkObject.
const HildonCaption*	gobj () const
	Provides access to the underlying C GtkObject.
	Caption (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)
	Caption (const Glib::ustring& value, Gtk::Widget& child, Gtk::Widget& icon, CaptionStatus flag=CAPTION_OPTIONAL)
	Caption (const Glib::ustring& value, Gtk::Widget& child, CaptionStatus flag=CAPTION_OPTIONAL)
Glib::RefPtr<Gtk::SizeGroup>	get_size_group ()
	Queries given captioned control for the Gtk::SizeGroup assigned to it.
Glib::RefPtr< const Gtk::SizeGroup >	get_size_group () const
	Queries given captioned control for the Gtk::SizeGroup assigned to it.
void	set_size_group (const Glib::RefPtr<Gtk::SizeGroup>& new_group)
	Sets a Gtk::SizeGroup of a given captioned control.
bool	is_mandatory () const
	Queries whether caption is mandatory.
void	set_status (CaptionStatus flag)
	Sets caption's status.
CaptionStatus	get_status () const
	Gets caption's status.
void	set_icon_position (CaptionIconPosition pos)
	Sets caption's icon position.
CaptionIconPosition	get_icon_position () const
	Gets caption's icon position.
void	set_icon_image (Gtk::Widget& icon)
	Sets the icon image widget to be used by caption.
Gtk::Widget*	get_icon_image ()
	Gets the icon image widget used by caption.
const Gtk::Widget*	get_icon_image () const
	Gets the icon image widget used by caption.
void	set_label (const Glib::ustring& label)
	Sets the label text that appears before the control.
Glib::ustring	get_label () const
	Gets the label of the Hildon::Caption.
void	set_separator (const Glib::ustring& separator)
	Sets the separator character that appears after the label.
Glib::ustring	get_separator () const
	Gets the separator string of the Hildon::Caption.
void	set_label_alignment (float alignment)
	Sets the vertical alignment to be used for the text part of the caption.
float	get_label_alignment () const
	Gets current vertical alignment for the text part.
void	set_child_expand (bool expand=true)
	Sets child expandability.
bool	get_child_expand () const
	Gets childs expandability.
void	set_label_markup (const Glib::ustring& markup)
	Sets the label markup text that appears before the control.
Glib::SignalProxy0<void>	signal_activate ()
Related Functions
(Note that these are not member functions.)
Hildon::Caption*	wrap (HildonCaption* object, bool take_copy=false)
	A Glib::wrap() method for this object.

Hildon::Caption Class Reference [Widgets]

Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Hildon::Caption Class Reference
[Widgets]