[gnome-desktop] gnome-rr-labeler: Add some documentation to keep vuntz happy
- From: Robert Ancell <rancell src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-desktop] gnome-rr-labeler: Add some documentation to keep vuntz happy
- Date: Mon, 2 May 2011 05:56:37 +0000 (UTC)
commit b3c809e0ec611db269dd38fad20649953713d030
Author: Robert Ancell <robert ancell canonical com>
Date: Mon May 2 15:56:25 2011 +1000
gnome-rr-labeler: Add some documentation to keep vuntz happy
libgnome-desktop/gnome-rr-labeler.c | 31 +++++++++++++++++++++++++++++++
1 files changed, 31 insertions(+), 0 deletions(-)
---
diff --git a/libgnome-desktop/gnome-rr-labeler.c b/libgnome-desktop/gnome-rr-labeler.c
index 5e4db1d..ca10baf 100644
--- a/libgnome-desktop/gnome-rr-labeler.c
+++ b/libgnome-desktop/gnome-rr-labeler.c
@@ -444,6 +444,17 @@ setup_from_config (GnomeRRLabeler *labeler)
gnome_rr_labeler_show (labeler);
}
+/**
+ * gnome_rr_labeler_new:
+ * Create a GUI element that will display colored labels on each connected monitor.
+ * This is useful when users are required to identify which monitor is which, e.g. for
+ * for configuring multiple monitors.
+ * The labels will be shown by default, use gnome_rr_labeler_hide to hide them.
+ *
+ * @config: Configuration of the screens to label
+ *
+ * Returns: A new #GnomeRRLabeler
+ */
GnomeRRLabeler *
gnome_rr_labeler_new (GnomeRRConfig *config)
{
@@ -452,6 +463,12 @@ gnome_rr_labeler_new (GnomeRRConfig *config)
return g_object_new (GNOME_TYPE_RR_LABELER, "config", config, NULL);
}
+/**
+ * gnome_rr_labeler_show:
+ * Show the labels.
+ *
+ * @labeler: A #GnomeRRLabeler
+ */
void
gnome_rr_labeler_show (GnomeRRLabeler *labeler)
{
@@ -481,6 +498,12 @@ gnome_rr_labeler_show (GnomeRRLabeler *labeler)
}
}
+/**
+ * gnome_rr_labeler_hide:
+ * Hide ouput labels.
+ *
+ * @labeler: A #GnomeRRLabeler
+ */
void
gnome_rr_labeler_hide (GnomeRRLabeler *labeler)
{
@@ -503,6 +526,14 @@ gnome_rr_labeler_hide (GnomeRRLabeler *labeler)
priv->windows = NULL;
}
+/**
+ * gnome_rr_labeler_get_color_for_output:
+ * Get the color used for the label on a given output (monitor).
+ *
+ * @labeler: A #GnomeRRLabeler
+ * @output: Output device (i.e. monitor) to query
+ * @color_out: (out): Color of selected monitor.
+ */
void
gnome_rr_labeler_get_color_for_output (GnomeRRLabeler *labeler, GnomeRROutputInfo *output, GdkColor *color_out)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]