Indicator Display Objects

Merge lp:~robert-ancell/ido/lp582985 into lp:ido/13.04

  1. lp582985
  2. Merge into trunk.13.04
Proposed by Robert Ancell
Status: Merged
Approved by: Didier Roche-Tolomelli
Approved revision: 123
Merged at revision: 122
Proposed branch: lp:~robert-ancell/ido/lp582985
Merge into: lp:ido/13.04
Diff against target: 858 lines (+366/-40)
13 files modified
configure.ac (+9/-0)
debian/control (+17/-0)
debian/gir1.2-ido3-0.1.install (+1/-0)
debian/libido3-0.1-dev.install (+2/-0)
src/Makefile.am (+53/-0)
src/idocalendarmenuitem.c (+77/-7)
src/idoentrymenuitem.c (+18/-4)
src/idomessagedialog.c (+20/-1)
src/idorange.c (+2/-0)
src/idoscalemenuitem.c (+62/-22)
src/idoscalemenuitem.h (+2/-2)
src/idoswitchmenuitem.c (+15/-4)
src/idotimeline.c (+88/-0)
To merge this branch: bzr merge lp:~robert-ancell/ido/lp582985
Reviewer Review Type Date Requested Status
PS Jenkins bot (community) continuous-integration Needs Fixing
Mathieu Trudel-Lapierre Approve
Review via email: mp+139791@code.launchpad.net

Commit message

Add introspection and vala support

To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Continuous integration, rev:121
http://jenkins.qa.ubuntu.com/job/ido-ci/18/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=coverity-raring,flavor=amd64/18/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=raring,flavor=i386/18/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/ido-ci/18//rebuild/?

review: Needs Fixing (continuous-integration)
Revision history for this message
Robert Ancell (robert-ancell) wrote :

I think the build failure might be because the packaging branch that Jenkins is using won't have the dependencies required for this? I can update the packaging but not sure where it is...

Revision history for this message
Mathieu Trudel-Lapierre (cyphermox) wrote :

Correct, given that we now use "inline" packaging (split mode in bzr), you'll want to add gobject-introspection to the build-depends.

review: Needs Fixing
Revision history for this message
Robert Ancell (robert-ancell) wrote :

Whoops, I was looking at libindicate. Now I notice debian/ is in ido. Too many i* names...

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Continuous integration, rev:122
http://jenkins.qa.ubuntu.com/job/ido-ci/19/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=raring,flavor=amd64/19/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=raring,flavor=i386/19/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/ido-ci/19//rebuild/?

review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Continuous integration, rev:123
http://jenkins.qa.ubuntu.com/job/ido-ci/20/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=raring,flavor=amd64/20/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=raring,flavor=i386/20/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/ido-ci/20//rebuild/?

review: Needs Fixing (continuous-integration)
Revision history for this message
Robert Ancell (robert-ancell) wrote :

Hmm, the amd64 build failure seems to be something to do with Xvfb? I can't trigger a rebuild it seems, can someone?

Revision history for this message
Allan LeSage (allanlesage) wrote :

Let me do a test build Robert, will report here.

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

PASSED: Continuous integration, rev:123
http://jenkins.qa.ubuntu.com/job/ido-ci/23/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=raring,flavor=amd64/23/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ido-ci/./build=pbuilder,distribution=raring,flavor=i386/23/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/ido-ci/23//rebuild/?

review: Approve (continuous-integration)
Revision history for this message
Allan LeSage (allanlesage) wrote :

Fixed the tests separately (in https://code.launchpad.net/~allanlesage/ido/remove-Xvfb-auto-test-override/+merge/140307).

Revision history for this message
Robert Ancell (robert-ancell) wrote :

Thanks Allan!

Revision history for this message
Mathieu Trudel-Lapierre (cyphermox) wrote :

Approve

review: Approve
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Autolanding.
No commit message was specified.

review: Needs Fixing (continuous-integration)
Revision history for this message
Allan LeSage (allanlesage) wrote :

The "use description for commit" option was set for this build--attempting again.

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Autolanding.
No commit message was specified.

review: Needs Fixing (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'configure.ac'
2--- configure.ac 2012-11-08 15:37:00 +0000
3+++ configure.ac 2012-12-15 07:41:19 +0000
4@@ -123,6 +123,14 @@
5 AC_SUBST(COVERAGE_CXXFLAGS)
6 AC_SUBST(COVERAGE_LDFLAGS)
7
8+dnl = GObject Introspection ===================================================
9+
10+GOBJECT_INTROSPECTION_CHECK([0.6.7])
11+
12+dnl = Vala API Generation =====================================================
13+
14+AC_PATH_PROG([VALA_API_GEN], [vapigen])
15+
16 dnl = Google Test Framework ===================================================
17
18 m4_include([m4/gtest.m4])
19@@ -152,6 +160,7 @@
20 echo ""
21 echo " Prefix : ${prefix}"
22 echo " gcov : ${use_gcov}"
23+echo " introspection: ${enable_introspection}"
24 echo ""
25 echo " Documentation: ${enable_gtk_doc}"
26 echo ""
27
28=== modified file 'debian/control'
29--- debian/control 2012-12-05 15:40:53 +0000
30+++ debian/control 2012-12-15 07:41:19 +0000
31@@ -11,6 +11,11 @@
32 libglib2.0-dev (>=2.14.0),
33 libgtk-3-dev (>= 3.0),
34 gtk-doc-tools,
35+ gobject-introspection,
36+ libgirepository1.0-dev,
37+ gir1.2-glib-2.0,
38+ gir1.2-gtk-2.0,
39+ valac-0.16
40 Standards-Version: 3.9.3
41 Homepage: https://launchpad.net/ido
42 # If you aren't a member of ~indicator-applet-developers but need to upload
43@@ -44,3 +49,15 @@
44 system indicators
45 .
46 This package contains files that are needed to build GTK+ 3 applications.
47+
48+Package: gir1.2-ido3-0.1
49+Section: libs
50+Architecture: any
51+Depends: ${misc:Depends},
52+ libido3-0.1-0 (>= ${binary:Version}),
53+ ${gir:Depends}
54+Description: Typelib file for libido3-0.1
55+ Shared library providing extra gtk menu items for display in system indicators.
56+ .
57+ This package can be used by other packages using the GIRepository format to
58+ generate dynamic bindings for libido3-0.1.
59
60=== added file 'debian/gir1.2-ido3-0.1.install'
61--- debian/gir1.2-ido3-0.1.install 1970-01-01 00:00:00 +0000
62+++ debian/gir1.2-ido3-0.1.install 2012-12-15 07:41:19 +0000
63@@ -0,0 +1,1 @@
64+usr/lib/*/girepository-1.0 /usr/lib
65
66=== modified file 'debian/libido3-0.1-dev.install'
67--- debian/libido3-0.1-dev.install 2012-11-19 18:58:43 +0000
68+++ debian/libido3-0.1-dev.install 2012-12-15 07:41:19 +0000
69@@ -1,3 +1,5 @@
70 usr/include/libido3-*
71 usr/lib/*/pkgconfig/libido3-*
72 usr/lib/*/libido3-*.so
73+usr/share/vala
74+usr/share/gir-1.0
75
76=== modified file 'src/Makefile.am'
77--- src/Makefile.am 2012-08-22 14:39:22 +0000
78+++ src/Makefile.am 2012-12-15 07:41:19 +0000
79@@ -1,3 +1,5 @@
80+CLEANFILES =
81+
82 VER=3
83 lib_LTLIBRARIES = libido3-0.1.la
84
85@@ -94,3 +96,54 @@
86 idotypebuiltins.h \
87 idotypebuiltins.c
88
89+-include $(INTROSPECTION_MAKEFILE)
90+INTROSPECTION_GIRS =
91+INTROSPECTION_SCANNER_ARGS = \
92+ --symbol-prefix=ido \
93+ --warn-all \
94+ --identifier-prefix=Ido
95+
96+if HAVE_INTROSPECTION
97+
98+Ido3-0.1.gir: libido3-0.1.la
99+Ido3_0_1_gir_INCLUDES = Gtk-3.0
100+Ido3_0_1_gir_CFLAGS =
101+Ido3_0_1_gir_LIBS = libido3-0.1.la
102+Ido3_0_1_gir_FILES = \
103+ idocalendarmenuitem.h \
104+ idoentrymenuitem.h \
105+ idomessagedialog.h \
106+ idorange.h \
107+ idoscalemenuitem.h \
108+ idoswitchmenuitem.h \
109+ idotimeline.h \
110+ $(libido_0_1_la_SOURCES)
111+Ido3_0_1_gir_NAMESPACE = Ido3
112+Ido3_0_1_gir_VERSION = 0.1
113+Ido3_0_1_gir_SCANNER_FLAGS = $(INTROSPECTION_SCANNER_ARGS)
114+
115+INTROSPECTION_GIRS += Ido3-0.1.gir
116+
117+girdir = $(datadir)/gir-1.0
118+gir_DATA = $(INTROSPECTION_GIRS)
119+
120+typelibdir = $(libdir)/girepository-1.0
121+typelib_DATA = $(INTROSPECTION_GIRS:.gir=.typelib)
122+
123+CLEANFILES += $(gir_DATA) $(typelib_DATA)
124+
125+endif
126+
127+if HAVE_INTROSPECTION
128+
129+vapidir = $(datadir)/vala/vapi
130+vapi_DATA = Ido3-0.1.vapi
131+
132+Ido3-0.1.vapi: Ido3-0.1.gir
133+ $(VALA_API_GEN) --library=Ido3-0.1 \
134+ --pkg gtk+-3.0 \
135+ $<
136+
137+CLEANFILES += $(vapi_DATA)
138+
139+endif
140
141=== modified file 'src/idocalendarmenuitem.c'
142--- src/idocalendarmenuitem.c 2012-09-20 04:32:58 +0000
143+++ src/idocalendarmenuitem.c 2012-12-15 07:41:19 +0000
144@@ -324,21 +324,44 @@
145 g_signal_emit_by_name (item, "day-selected-double-click", NULL);
146 }
147
148-/* Public API */
149+/**
150+ * ido_calendar_menu_item_new:
151+ *
152+ * Creates a new #IdoCalendarMenuItem
153+ *
154+ * Return Value: a new #IdoCalendarMenuItem.
155+ **/
156 GtkWidget *
157 ido_calendar_menu_item_new (void)
158 {
159 return g_object_new (IDO_TYPE_CALENDAR_MENU_ITEM, NULL);
160 }
161
162+/**
163+ * ido_calendar_menu_item_get_calendar:
164+ * @menuitem: A #IdoCalendarMenuItem
165+ *
166+ * Returns the calendar associated with this menu item.
167+ *
168+ * Return Value: (transfer none): The #GtkCalendar used in this item.
169+ */
170 GtkWidget *
171-ido_calendar_menu_item_get_calendar (IdoCalendarMenuItem *item)
172+ido_calendar_menu_item_get_calendar (IdoCalendarMenuItem *menuitem)
173 {
174- g_return_val_if_fail (IDO_IS_CALENDAR_MENU_ITEM (item), NULL);
175+ g_return_val_if_fail (IDO_IS_CALENDAR_MENU_ITEM (menuitem), NULL);
176
177- return item->priv->calendar;
178+ return menuitem->priv->calendar;
179 }
180
181+/**
182+ * ido_calendar_menu_item_mark_day:
183+ * @menuitem: A #IdoCalendarMenuItem
184+ * @day: the day number to unmark between 1 and 31.
185+ *
186+ * Places a visual marker on a particular day.
187+ *
188+ * Return Value: #TRUE
189+ */
190 gboolean
191 ido_calendar_menu_item_mark_day (IdoCalendarMenuItem *menuitem, guint day)
192 {
193@@ -348,6 +371,15 @@
194 return TRUE;
195 }
196
197+/**
198+ * ido_calendar_menu_item_unmark_day:
199+ * @menuitem: A #IdoCalendarMenuItem
200+ * @day: the day number to unmark between 1 and 31.
201+ *
202+ * Removes the visual marker from a particular day.
203+ *
204+ * Return Value: #TRUE
205+ */
206 gboolean
207 ido_calendar_menu_item_unmark_day (IdoCalendarMenuItem *menuitem, guint day)
208 {
209@@ -357,6 +389,12 @@
210 return TRUE;
211 }
212
213+/**
214+ * ido_calendar_menu_item_clear_marks:
215+ * @menuitem: A #IdoCalendarMenuItem
216+ *
217+ * Remove all visual markers.
218+ */
219 void
220 ido_calendar_menu_item_clear_marks (IdoCalendarMenuItem *menuitem)
221 {
222@@ -365,6 +403,13 @@
223 gtk_calendar_clear_marks(GTK_CALENDAR (menuitem->priv->calendar));
224 }
225
226+/**
227+ * ido_calendar_menu_item_set_display_options:
228+ * @menuitem: A #IdoCalendarMenuItem
229+ * @flags: the display options to set
230+ *
231+ * Set the display options for the calendar.
232+ */
233 void
234 ido_calendar_menu_item_set_display_options (IdoCalendarMenuItem *menuitem, GtkCalendarDisplayOptions flags)
235 {
236@@ -373,6 +418,14 @@
237 gtk_calendar_set_display_options (GTK_CALENDAR (menuitem->priv->calendar), flags);
238 }
239
240+/**
241+ * ido_calendar_menu_item_get_display_options:
242+ * @menuitem: A #IdoCalendarMenuItem
243+ *
244+ * Get the display options for the calendar.
245+ *
246+ * Return Value: the display options in use
247+ */
248 GtkCalendarDisplayOptions
249 ido_calendar_menu_item_get_display_options (IdoCalendarMenuItem *menuitem)
250 {
251@@ -381,6 +434,15 @@
252 return gtk_calendar_get_display_options (GTK_CALENDAR (menuitem->priv->calendar));
253 }
254
255+/**
256+ * ido_calendar_menu_item_get_date:
257+ * @menuitem: A #IdoCalendarMenuItem
258+ * @year: (out) (allow-none): location to store the year as a decimal number (e.g. 2011), or #NULL.
259+ * @month: (out) (allow-none): location to store the month number (between 0 and 11), or #NULL.
260+ * @day: (out) (allow-none): location to store the day number (between 1 and 31), or #NULL.
261+ *
262+ * Gets the selected date.
263+ */
264 void
265 ido_calendar_menu_item_get_date (IdoCalendarMenuItem *menuitem,
266 guint *year,
267@@ -391,6 +453,17 @@
268 gtk_calendar_get_date (GTK_CALENDAR (menuitem->priv->calendar), year, month, day);
269 }
270
271+/**
272+ * ido_calendar_menu_item_set_date:
273+ * @menuitem: A #IdoCalendarMenuItem
274+ * @year: the year to show (e.g. 2011).
275+ * @month: a month number (between 0 and 11).
276+ * @day: The day number (between 1 and 31).
277+ *
278+ * Set the date shown on the calendar.
279+ *
280+ * Return Value: #TRUE
281+ */
282 gboolean
283 ido_calendar_menu_item_set_date (IdoCalendarMenuItem *menuitem,
284 guint year,
285@@ -402,6 +475,3 @@
286 gtk_calendar_select_day (GTK_CALENDAR (menuitem->priv->calendar), day);
287 return TRUE;
288 }
289-
290-
291-
292
293=== modified file 'src/idoentrymenuitem.c'
294--- src/idoentrymenuitem.c 2012-08-22 14:41:36 +0000
295+++ src/idoentrymenuitem.c 2012-12-15 07:41:19 +0000
296@@ -260,17 +260,31 @@
297 GTK_DIR_TAB_FORWARD);
298 }
299
300-/* Public API */
301+/**
302+ * ido_entry_menu_item_new:
303+ *
304+ * Creates a new #IdoEntryMenuItem.
305+ *
306+ * Return Value: the newly created #IdoEntryMenuItem.
307+ */
308 GtkWidget *
309 ido_entry_menu_item_new (void)
310 {
311 return g_object_new (IDO_TYPE_ENTRY_MENU_ITEM, NULL);
312 }
313
314+/**
315+ * ido_entry_menu_item_get_entry:
316+ * @menuitem: The #IdoEntryMenuItem.
317+ *
318+ * Get the #GtkEntry used in this menu item.
319+ *
320+ * Return Value: (transfer none): The #GtkEntry inside this menu item.
321+ */
322 GtkWidget *
323-ido_entry_menu_item_get_entry (IdoEntryMenuItem *item)
324+ido_entry_menu_item_get_entry (IdoEntryMenuItem *menuitem)
325 {
326- g_return_val_if_fail (IDO_IS_ENTRY_MENU_ITEM (item), NULL);
327+ g_return_val_if_fail (IDO_IS_ENTRY_MENU_ITEM (menuitem), NULL);
328
329- return item->priv->entry;
330+ return menuitem->priv->entry;
331 }
332
333=== modified file 'src/idomessagedialog.c'
334--- src/idomessagedialog.c 2012-08-22 14:44:00 +0000
335+++ src/idomessagedialog.c 2012-12-15 07:41:19 +0000
336@@ -258,7 +258,7 @@
337 * dialog it will expand to provide the secondary message
338 * and the action buttons.
339 *
340- * Return value: a new #IdoMessageDialog
341+ * Return Value: a new #IdoMessageDialog
342 **/
343 GtkWidget*
344 ido_message_dialog_new (GtkWindow *parent,
345@@ -305,6 +305,25 @@
346 return widget;
347 }
348
349+/**
350+ * ido_message_dialog_new_with_markup:
351+ * @parent: transient parent, or %NULL for none
352+ * @flags: flags
353+ * @type: type of message
354+ * @buttons: a set of buttons to use
355+ * @message_format: printf()-style format string, or %NULL
356+ * @Varargs: arguments for @message_format. They will be escaped to allow valid XML.
357+ *
358+ * Creates a new message dialog, which is based upon
359+ * GtkMessageDialog so it shares API and functionality
360+ * with it. IdoMessageDialog differs in that it has two
361+ * states. The initial state hides the action buttons
362+ * and the secondary message. When a user clicks on the
363+ * dialog it will expand to provide the secondary message
364+ * and the action buttons.
365+ *
366+ * Return Value: a new #IdoMessageDialog
367+ **/
368 GtkWidget*
369 ido_message_dialog_new_with_markup (GtkWindow *parent,
370 GtkDialogFlags flags,
371
372=== modified file 'src/idorange.c'
373--- src/idorange.c 2012-08-27 20:01:07 +0000
374+++ src/idorange.c 2012-12-15 07:41:19 +0000
375@@ -172,6 +172,8 @@
376 * @style: The range style
377 *
378 * Creates a new #IdoRange widget.
379+ *
380+ * Return Value: A new #IdoRange
381 **/
382 GtkWidget *
383 ido_range_new (GObject *adj,
384
385=== modified file 'src/idoscalemenuitem.c'
386--- src/idoscalemenuitem.c 2012-08-27 20:01:07 +0000
387+++ src/idoscalemenuitem.c 2012-12-15 07:41:19 +0000
388@@ -309,6 +309,12 @@
389 FALSE,
390 G_PARAM_READWRITE));
391
392+ /**
393+ * IdoScaleMenuItem::slider-grabbed:
394+ * @menuitem: The #IdoScaleMenuItem emitting the signal.
395+ *
396+ * The ::slider-grabbed signal is emitted when the pointer selects the slider.
397+ */
398 signals[SLIDER_GRABBED] = g_signal_new ("slider-grabbed",
399 G_OBJECT_CLASS_TYPE (gobject_class),
400 G_SIGNAL_RUN_FIRST,
401@@ -317,6 +323,12 @@
402 g_cclosure_marshal_VOID__VOID,
403 G_TYPE_NONE, 0);
404
405+ /**
406+ * IdoScaleMenuItem::slider-released:
407+ * @menuitem: The #IdoScaleMenuItem emitting the signal.
408+ *
409+ * The ::slider-released signal is emitted when the pointer releases the slider.
410+ */
411 signals[SLIDER_RELEASED] = g_signal_new ("slider-released",
412 G_OBJECT_CLASS_TYPE (gobject_class),
413 G_SIGNAL_RUN_FIRST,
414@@ -325,6 +337,12 @@
415 g_cclosure_marshal_VOID__VOID,
416 G_TYPE_NONE, 0);
417
418+ /**
419+ * IdoScaleMenuItem::primary-clicked:
420+ * @menuitem: The #IdoScaleMenuItem emitting the signal.
421+ *
422+ * The ::primary-clicked signal is emitted when the pointer clicks the primary label.
423+ */
424 signals[PRIMARY_CLICKED] = g_signal_new ("primary-clicked",
425 G_TYPE_FROM_CLASS (item_class),
426 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
427@@ -334,6 +352,12 @@
428 G_TYPE_NONE, /* return type */
429 0 /* n_params */);
430
431+ /**
432+ * IdoScaleMenuItem::secondary-clicked:
433+ * @menuitem: The #IdoScaleMenuItem emitting the signal.
434+ *
435+ * The ::secondary-clicked signal is emitted when the pointer clicks the secondary label.
436+ */
437 signals[SECONDARY_CLICKED] = g_signal_new ("secondary-clicked",
438 G_TYPE_FROM_CLASS (item_class),
439 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
440@@ -625,9 +649,10 @@
441 * @label: the text of the new menu item.
442 * @size: The size style of the range.
443 * @adjustment: A #GtkAdjustment describing the slider value.
444- * @returns: a new #IdoScaleMenuItem.
445 *
446 * Creates a new #IdoScaleMenuItem with an empty label.
447+ *
448+ * Return Value: a new #IdoScaleMenuItem.
449 **/
450 GtkWidget*
451 ido_scale_menu_item_new (const gchar *label,
452@@ -647,9 +672,10 @@
453 * @min: The minimum value of the slider.
454 * @max: The maximum value of the slider.
455 * @step: The step increment of the slider.
456- * @returns: a new #IdoScaleMenuItem.
457 *
458 * Creates a new #IdoScaleMenuItem containing a label.
459+ *
460+ * Return Value: a new #IdoScaleMenuItem.
461 **/
462 GtkWidget*
463 ido_scale_menu_item_new_with_range (const gchar *label,
464@@ -671,9 +697,10 @@
465 /**
466 * ido_scale_menu_item_get_scale:
467 * @menuitem: The #IdoScaleMenuItem
468- * @returns: A pointer to the scale widget.
469 *
470 * Retrieves the scale widget.
471+ *
472+ * Return Value: (transfer none): The #IdoRange in this item
473 **/
474 GtkWidget*
475 ido_scale_menu_item_get_scale (IdoScaleMenuItem *menuitem)
476@@ -690,10 +717,11 @@
477 /**
478 * ido_scale_menu_item_get_style:
479 * @menuitem: The #IdoScaleMenuItem
480- * @returns: A #IdoScaleMenuItemStyle enum describing the style.
481 *
482 * Retrieves the type of widgets being used for the primary and
483 * secondary widget slots. This could be images, labels, or nothing.
484+ *
485+ * Return Value: A #IdoScaleMenuItemStyle enum describing the style.
486 **/
487 IdoScaleMenuItemStyle
488 ido_scale_menu_item_get_style (IdoScaleMenuItem *menuitem)
489@@ -707,6 +735,14 @@
490 return priv->style;
491 }
492
493+/**
494+ * ido_scale_menu_item_set_style:
495+ * @menuitem: The #IdoScaleMenuItem
496+ * @style: Set the style use for the primary and secondary widget slots.
497+ *
498+ * Sets the type of widgets being used for the primary and
499+ * secondary widget slots. This could be images, labels, or nothing.
500+ **/
501 void
502 ido_scale_menu_item_set_style (IdoScaleMenuItem *menuitem,
503 IdoScaleMenuItemStyle style)
504@@ -725,11 +761,12 @@
505 /**
506 * ido_scale_menu_item_get_primary_image:
507 * @menuitem: The #IdoScaleMenuItem
508- * @returns: A #GtkWidget pointer for the primary image.
509 *
510 * Retrieves a pointer to the image widget used in the primary slot.
511 * Whether this is visible depends upon the return value from
512 * ido_scale_menu_item_get_style().
513+ *
514+ * Return Value: (transfer none): A #GtkWidget pointer for the primary image.
515 **/
516 GtkWidget *
517 ido_scale_menu_item_get_primary_image (IdoScaleMenuItem *menuitem)
518@@ -746,11 +783,12 @@
519 /**
520 * ido_scale_menu_item_get_secondary_image:
521 * @menuitem: The #IdoScaleMenuItem
522- * @returns: A #GtkWidget pointer for the secondary image.
523 *
524 * Retrieves a pointer to the image widget used in the secondary slot.
525 * Whether this is visible depends upon the return value from
526 * ido_scale_menu_item_get_style().
527+ *
528+ * Return Value: (transfer none): A #GtkWidget pointer for the secondary image.
529 **/
530 GtkWidget *
531 ido_scale_menu_item_get_secondary_image (IdoScaleMenuItem *menuitem)
532@@ -767,11 +805,12 @@
533 /**
534 * ido_scale_menu_item_get_primary_label:
535 * @menuitem: The #IdoScaleMenuItem
536- * @returns: A const gchar* string of the label text.
537 *
538 * Retrieves a string of the text for the primary label widget.
539 * Whether this is visible depends upon the return value from
540 * ido_scale_menu_item_get_style().
541+ *
542+ * Return Value: The label text.
543 **/
544 const gchar*
545 ido_scale_menu_item_get_primary_label (IdoScaleMenuItem *menuitem)
546@@ -786,13 +825,14 @@
547 }
548
549 /**
550- * ido_scale_menu_item_get_primary_label:
551+ * ido_scale_menu_item_get_secondary_label:
552 * @menuitem: The #IdoScaleMenuItem
553- * @returns: A const gchar* string of the label text.
554 *
555- * Retrieves a string of the text for the primary label widget.
556+ * Retrieves a string of the text for the secondary label widget.
557 * Whether this is visible depends upon the return value from
558 * ido_scale_menu_item_get_style().
559+ *
560+ * Return Value: The label text.
561 **/
562 const gchar*
563 ido_scale_menu_item_get_secondary_label (IdoScaleMenuItem *menuitem)
564@@ -809,7 +849,7 @@
565 /**
566 * ido_scale_menu_item_set_primary_label:
567 * @menuitem: The #IdoScaleMenuItem
568- * @label: A string containing the label text
569+ * @label: The label text
570 *
571 * Sets the text for the label widget in the primary slot. This
572 * widget will only be visibile if the return value of
573@@ -832,11 +872,11 @@
574 }
575
576 /**
577- * ido_scale_menu_item_set_primary_label:
578+ * ido_scale_menu_item_set_secondary_label:
579 * @menuitem: The #IdoScaleMenuItem
580- * @label: A string containing the label text
581+ * @label: The label text
582 *
583- * Sets the text for the label widget in the primary slot. This
584+ * Sets the text for the label widget in the secondary slot. This
585 * widget will only be visibile if the return value of
586 * ido_scale_menu_item_get_style() is set to %IDO_SCALE_MENU_ITEM_STYLE_LABEL.
587 **/
588@@ -859,16 +899,16 @@
589 /**
590 * ido_scale_menu_item_primary_clicked:
591 * @menuitem: the #IdoScaleMenuItem
592- *
593+ *
594 * Emits the "primary-clicked" signal.
595 *
596 * The default handler for this signal lowers the scale's
597 * adjustment to its lower bound.
598 */
599 void
600-ido_scale_menu_item_primary_clicked (IdoScaleMenuItem * item)
601+ido_scale_menu_item_primary_clicked (IdoScaleMenuItem * menuitem)
602 {
603- g_signal_emit (item, signals[PRIMARY_CLICKED], 0);
604+ g_signal_emit (menuitem, signals[PRIMARY_CLICKED], 0);
605 }
606 static void
607 default_primary_clicked_handler (IdoScaleMenuItem * item)
608@@ -880,18 +920,18 @@
609 }
610
611 /**
612- * ido_scale_menu_item_primary_clicked:
613+ * ido_scale_menu_item_secondary_clicked:
614 * @menuitem: the #IdoScaleMenuItem
615- *
616- * Emits the "primary-clicked" signal.
617+ *
618+ * Emits the "secondary-clicked" signal.
619 *
620 * The default handler for this signal raises the scale's
621 * adjustment to its upper bound.
622 */
623 void
624-ido_scale_menu_item_secondary_clicked (IdoScaleMenuItem * item)
625+ido_scale_menu_item_secondary_clicked (IdoScaleMenuItem * menuitem)
626 {
627- g_signal_emit (item, signals[SECONDARY_CLICKED], 0);
628+ g_signal_emit (menuitem, signals[SECONDARY_CLICKED], 0);
629 }
630 static void
631 default_secondary_clicked_handler (IdoScaleMenuItem * item)
632
633=== modified file 'src/idoscalemenuitem.h'
634--- src/idoscalemenuitem.h 2012-03-10 06:04:36 +0000
635+++ src/idoscalemenuitem.h 2012-12-15 07:41:19 +0000
636@@ -61,8 +61,8 @@
637 GtkMenuItemClass parent_class;
638
639 /* signal default handlers */
640- void (*primary_clicked)(IdoScaleMenuItem * self);
641- void (*secondary_clicked)(IdoScaleMenuItem * self);
642+ void (*primary_clicked)(IdoScaleMenuItem * menuitem);
643+ void (*secondary_clicked)(IdoScaleMenuItem * menuitem);
644 };
645
646
647
648=== modified file 'src/idoswitchmenuitem.c'
649--- src/idoswitchmenuitem.c 2012-08-21 21:43:49 +0000
650+++ src/idoswitchmenuitem.c 2012-12-15 07:41:19 +0000
651@@ -101,16 +101,27 @@
652 return TRUE; /* stop the event so that it doesn't trigger popdown() */
653 }
654
655-/***
656-**** Public API
657-***/
658-
659+/**
660+ * ido_switch_menu_item_new:
661+ *
662+ * Creates a new #IdoSwitchMenuItem
663+ *
664+ * Return Value: a new #IdoSwitchMenuItem.
665+ **/
666 GtkWidget *
667 ido_switch_menu_item_new (void)
668 {
669 return g_object_new (IDO_TYPE_SWITCH_MENU_ITEM, NULL);
670 }
671
672+/**
673+ * ido_switch_menu_item_get_content_area:
674+ * @item: The #IdoSwitchMenuItem.
675+ *
676+ * Get the #GtkContainer to add additional widgets into.
677+ *
678+ * Return Value: (transfer none): The #GtkContainer to add additional widgets into.
679+ **/
680 GtkContainer *
681 ido_switch_menu_item_get_content_area (IdoSwitchMenuItem * item)
682 {
683
684=== modified file 'src/idotimeline.c'
685--- src/idotimeline.c 2011-06-01 19:36:43 +0000
686+++ src/idotimeline.c 2012-12-15 07:41:19 +0000
687@@ -132,6 +132,12 @@
688 GDK_TYPE_SCREEN,
689 G_PARAM_READWRITE));
690
691+ /**
692+ * IdoTimeline::started:
693+ * @timeline: The #IdoTimeline emitting the signal.
694+ *
695+ * The ::started signal is emitted when the timeline starts.
696+ */
697 signals[STARTED] =
698 g_signal_new ("started",
699 G_TYPE_FROM_CLASS (object_class),
700@@ -141,6 +147,12 @@
701 g_cclosure_marshal_VOID__VOID,
702 G_TYPE_NONE, 0);
703
704+ /**
705+ * IdoTimeline::paused:
706+ * @timeline: The #IdoTimeline emitting the signal.
707+ *
708+ * The ::paused signal is emitted when the timeline pauses.
709+ */
710 signals[PAUSED] =
711 g_signal_new ("paused",
712 G_TYPE_FROM_CLASS (object_class),
713@@ -150,6 +162,12 @@
714 g_cclosure_marshal_VOID__VOID,
715 G_TYPE_NONE, 0);
716
717+ /**
718+ * IdoTimeline::finished:
719+ * @timeline: The #IdoTimeline emitting the signal.
720+ *
721+ * The ::paused signal is emitted when the timeline finishes.
722+ */
723 signals[FINISHED] =
724 g_signal_new ("finished",
725 G_TYPE_FROM_CLASS (object_class),
726@@ -159,6 +177,13 @@
727 g_cclosure_marshal_VOID__VOID,
728 G_TYPE_NONE, 0);
729
730+ /**
731+ * IdoTimeline::frame:
732+ * @timeline: The #IdoTimeline emitting the signal.
733+ * @progress: The progress position for this frame from 0.0 (start) to 1.0 (end).
734+ *
735+ * The ::frame signal is emitted when a frame should be drawn.
736+ */
737 signals[FRAME] =
738 g_signal_new ("frame",
739 G_TYPE_FROM_CLASS (object_class),
740@@ -342,6 +367,15 @@
741 NULL);
742 }
743
744+/**
745+ * ido_timeline_new_for_screen:
746+ * @duration: duration in milliseconds for the timeline
747+ * @screen: Screen to start on.
748+ *
749+ * Creates a new #IdoTimeline with the specified number of frames on the given screen.
750+ *
751+ * Return Value: the newly created #IdoTimeline
752+ **/
753 IdoTimeline *
754 ido_timeline_new_for_screen (guint duration,
755 GdkScreen *screen)
756@@ -573,6 +607,13 @@
757 }
758 }
759
760+/**
761+ * ido_timeline_set_duration:
762+ * @timeline: A #IdoTimeline
763+ * @duration: Duration in milliseconds.
764+ *
765+ * Set the animation duration.
766+ */
767 void
768 ido_timeline_set_duration (IdoTimeline *timeline,
769 guint duration)
770@@ -590,6 +631,14 @@
771 }
772 }
773
774+/**
775+ * ido_timeline_get_duration:
776+ * @timeline: A #IdoTimeline
777+ *
778+ * Set the animation duration.
779+ *
780+ * Return Value: Duration in milliseconds.
781+ */
782 guint
783 ido_timeline_get_duration (IdoTimeline *timeline)
784 {
785@@ -645,6 +694,13 @@
786 return priv->direction;
787 }
788
789+/**
790+ * ido_timeline_set_screen:
791+ * @timeline: A #IdoTimeline
792+ * @screen: A #GdkScreen to use
793+ *
794+ * Set the screen the timeline is running on.
795+ */
796 void
797 ido_timeline_set_screen (IdoTimeline *timeline,
798 GdkScreen *screen)
799@@ -664,6 +720,14 @@
800 g_object_notify (G_OBJECT (timeline), "screen");
801 }
802
803+/**
804+ * ido_timeline_get_screen:
805+ * @timeline: A #IdoTimeline
806+ *
807+ * Get the screen this timeline is running on.
808+ *
809+ * Return Value: (transfer none): The #GdkScreen this timeline is running on.
810+ */
811 GdkScreen *
812 ido_timeline_get_screen (IdoTimeline *timeline)
813 {
814@@ -675,6 +739,14 @@
815 return priv->screen;
816 }
817
818+/**
819+ * ido_timeline_get_progress:
820+ * @timeline: A #IdoTimeline
821+ *
822+ * Get the progress on the timeline.
823+ *
824+ * Return Value: The progress from 0.0 (start) to 1.0 (end)
825+ */
826 gdouble
827 ido_timeline_get_progress (IdoTimeline *timeline)
828 {
829@@ -686,6 +758,13 @@
830 return priv->progress;
831 }
832
833+/**
834+ * ido_timeline_set_progress:
835+ * @timeline: A #IdoTimeline
836+ * @progress: The progress from 0.0 (start) to 1.0 (end)
837+ *
838+ * Set the progress on the timeline.
839+ */
840 void
841 ido_timeline_set_progress (IdoTimeline *timeline, gdouble progress)
842 {
843@@ -707,6 +786,15 @@
844 ido_timeline_start (timeline);
845 }
846
847+/**
848+ * ido_timeline_calculate_progress:
849+ * @linear_progress: The progress from 0.0 (start) to 1.0 (end)
850+ * @progress_type: The progress transform to apply
851+ *
852+ * Transform a linear progress position using the given transform.
853+ *
854+ * Return Value: the progress position using the provided transform.
855+ */
856 gdouble
857 ido_timeline_calculate_progress (gdouble linear_progress,
858 IdoTimelineProgressType progress_type)

Subscribers

People subscribed via source and target branches