2 * This file is a part of hildon
4 * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
6 * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; version 2.1 of
11 * the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
25 #ifndef __HILDON_CAPTION_H__
26 #define __HILDON_CAPTION_H__
30 #include "hildon-enum-types.h"
34 typedef struct _HildonCaption HildonCaption;
36 typedef struct _HildonCaptionClass HildonCaptionClass;
38 #define HILDON_TYPE_CAPTION (hildon_caption_get_type())
40 #define HILDON_CAPTION(obj) \
41 (G_TYPE_CHECK_INSTANCE_CAST (obj, \
42 HILDON_TYPE_CAPTION, HildonCaption))
44 #define HILDON_CAPTION_CLASS(klass) \
45 (G_TYPE_CHECK_CLASS_CAST ((klass),\
46 HILDON_TYPE_CAPTION, HildonCaptionClass))
48 #define HILDON_IS_CAPTION(obj) \
49 (G_TYPE_CHECK_INSTANCE_TYPE (obj, HILDON_TYPE_CAPTION))
51 #define HILDON_IS_CAPTION_CLASS(klass) \
52 (G_TYPE_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_CAPTION))
55 * HildonCaptionStatus:
56 * @HILDON_CAPTION_OPTIONAL: Optional.
57 * @HILDON_CAPTION_MANDATORY: Mandatory.
59 * Keys to set the #HildonCaption to be optional or mandatory.
63 HILDON_CAPTION_OPTIONAL = 0,
64 HILDON_CAPTION_MANDATORY
65 } HildonCaptionStatus;
68 * HildonCaptionIconPosition:
69 * @HILDON_CAPTION_POSITION_LEFT: Show the icon on the left side.
70 * @HILDON_CAPTION_POSITION_RIGHT: Show the icon on the right side.
72 * Keys to set the icon placement in #HildonCaption.
77 HILDON_CAPTION_POSITION_LEFT = 0,
78 HILDON_CAPTION_POSITION_RIGHT
79 } HildonCaptionIconPosition;
88 struct _HildonCaptionClass
90 GtkEventBoxClass parent_class;
91 void (*activate) (HildonCaption *widget);
95 hildon_caption_get_type (void);
98 hildon_caption_new (GtkSizeGroup *group,
102 HildonCaptionStatus flag);
105 hildon_caption_get_size_group (const HildonCaption *caption);
108 hildon_caption_set_size_group (const HildonCaption *caption,
109 GtkSizeGroup *new_group );
112 hildon_caption_is_mandatory (const HildonCaption *caption);
115 hildon_caption_set_status (HildonCaption *caption,
116 HildonCaptionStatus flag);
119 hildon_caption_get_status (const HildonCaption *caption);
122 hildon_caption_set_icon_position (HildonCaption *caption,
123 HildonCaptionIconPosition pos );
125 HildonCaptionIconPosition
126 hildon_caption_get_icon_position (const HildonCaption *caption);
129 hildon_caption_set_icon_image (HildonCaption *caption,
133 hildon_caption_get_icon_image (const HildonCaption *caption);
136 hildon_caption_set_label (HildonCaption *caption,
137 const gchar *label );
140 hildon_caption_get_label (const HildonCaption *caption);
143 hildon_caption_set_separator (HildonCaption *caption,
144 const gchar *separator);
147 hildon_caption_get_separator (const HildonCaption *caption);
150 hildon_caption_set_label_alignment (HildonCaption *caption,
154 hildon_caption_get_label_alignment (HildonCaption *caption);
157 hildon_caption_set_child_expand (HildonCaption *caption,
161 hildon_caption_get_child_expand (const HildonCaption *caption);
164 hildon_caption_set_label_markup (HildonCaption *caption,
165 const gchar *markup);
169 #endif /* __HILDON_CAPTION_H__ */