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 (GTK_CHECK_CAST (obj, HILDON_TYPE_CAPTION, HildonCaption))
43 #define HILDON_CAPTION_CLASS(klass) \
44 (GTK_CHECK_CLASS_CAST ((klass),\
45 HILDON_TYPE_CAPTION, HildonCaptionClass))
47 #define HILDON_IS_CAPTION(obj) \
48 (GTK_CHECK_TYPE (obj, HILDON_TYPE_CAPTION))
50 #define HILDON_IS_CAPTION_CLASS(klass) \
51 (GTK_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_CAPTION))
54 * HildonCaptionStatus:
55 * @HILDON_CAPTION_OPTIONAL: Optional.
56 * @HILDON_CAPTION_MANDATORY: Mandatory.
58 * Keys to set the #HildonCaption to be optional or mandatory.
62 HILDON_CAPTION_OPTIONAL = 0,
63 HILDON_CAPTION_MANDATORY
64 } HildonCaptionStatus;
67 * HildonCaptionIconPosition:
68 * @HILDON_CAPTION_POSITION_LEFT: Show the icon on the left side.
69 * @HILDON_CAPTION_POSITION_RIGHT: Show the icon on the right side.
71 * Keys to set the icon placement in #HildonCaption.
76 HILDON_CAPTION_POSITION_LEFT = 0,
77 HILDON_CAPTION_POSITION_RIGHT
78 } HildonCaptionIconPosition;
87 struct _HildonCaptionClass
89 GtkEventBoxClass parent_class;
90 void (*activate) (HildonCaption *widget);
94 hildon_caption_get_type (void);
97 hildon_caption_new (GtkSizeGroup *group,
101 HildonCaptionStatus flag);
104 hildon_caption_get_size_group (const HildonCaption *caption);
107 hildon_caption_set_size_group (const HildonCaption *caption,
108 GtkSizeGroup *new_group );
111 hildon_caption_is_mandatory (const HildonCaption *caption);
114 hildon_caption_set_status (HildonCaption *caption,
115 HildonCaptionStatus flag);
118 hildon_caption_get_status (const HildonCaption *caption);
121 hildon_caption_set_icon_position (HildonCaption *caption,
122 HildonCaptionIconPosition pos );
124 HildonCaptionIconPosition
125 hildon_caption_get_icon_position (const HildonCaption *caption);
128 hildon_caption_set_icon_image (HildonCaption *caption,
132 hildon_caption_get_icon_image (const HildonCaption *caption);
135 hildon_caption_set_label (HildonCaption *caption,
136 const gchar *label );
139 hildon_caption_get_label (const HildonCaption *caption);
142 hildon_caption_set_separator (HildonCaption *caption,
143 const gchar *separator);
146 hildon_caption_get_separator (const HildonCaption *caption);
149 hildon_caption_set_label_alignment (HildonCaption *caption,
153 hildon_caption_get_label_alignment (HildonCaption *caption);
156 hildon_caption_set_child_expand (HildonCaption *caption,
160 hildon_caption_get_child_expand (const HildonCaption *caption);
163 hildon_caption_set_label_markup (HildonCaption *caption,
164 const gchar *markup);
168 #endif /* __HILDON_CAPTION_H__ */