diff options
| author | infirit <[email protected]> | 2015-07-20 21:23:21 +0200 |
|---|---|---|
| committer | infirit <[email protected]> | 2015-07-30 00:15:48 +0200 |
| commit | b6f2d9f8f4a82d1ddf075b2817d442f42840eb48 (patch) | |
| tree | 18f0726a83435ccd2edd1bec40ef646dd047c724 /libmate-desktop/mate-rr-labeler.c | |
| parent | b4af7eca1d880dd497fe8d9581905f950176378b (diff) | |
| download | mate-desktop-b6f2d9f8f4a82d1ddf075b2817d442f42840eb48.tar.bz2 mate-desktop-b6f2d9f8f4a82d1ddf075b2817d442f42840eb48.tar.xz | |
Add annotations and fix documentation syntax warnings
Diffstat (limited to 'libmate-desktop/mate-rr-labeler.c')
| -rw-r--r-- | libmate-desktop/mate-rr-labeler.c | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/libmate-desktop/mate-rr-labeler.c b/libmate-desktop/mate-rr-labeler.c index f7a2035..e65ced5 100644 --- a/libmate-desktop/mate-rr-labeler.c +++ b/libmate-desktop/mate-rr-labeler.c @@ -511,6 +511,17 @@ setup_from_config (MateRRLabeler *labeler) create_label_windows (labeler); } +/** + * mate_rr_labeler_new: + * @config: Configuration of the screens to label + * + * 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 mate_rr_labeler_hide to hide them. + * + * Returns: A new #GnomeRRLabeler + */ MateRRLabeler * mate_rr_labeler_new (MateRRConfig *config) { @@ -519,6 +530,12 @@ mate_rr_labeler_new (MateRRConfig *config) return g_object_new (MATE_TYPE_RR_LABELER, "config", config, NULL); } +/** + * mate_rr_labeler_hide: + * @labeler: A #MateRRLabeler + * + * Hide ouput labels. + */ void mate_rr_labeler_hide (MateRRLabeler *labeler) { @@ -542,6 +559,14 @@ mate_rr_labeler_hide (MateRRLabeler *labeler) } #if GTK_CHECK_VERSION (3, 0, 0) +/** + * mate_rr_labeler_get_rgba_for_output: + * @labeler: A #MateRRLabeler + * @output: Output device (i.e. monitor) to query + * @rgba_out: (out): Color of selected monitor. + * + * Get the color used for the label on a given output (monitor). + */ void mate_rr_labeler_get_rgba_for_output (MateRRLabeler *labeler, MateRROutputInfo *output, GdkRGBA *color_out) { @@ -569,6 +594,14 @@ mate_rr_labeler_get_rgba_for_output (MateRRLabeler *labeler, MateRROutputInfo *o } #endif +/** + * mate_rr_labeler_get_color_for_output: + * @labeler: A #MateRRLabeler + * @output: Output device (i.e. monitor) to query + * @color_out: (out): Color of selected monitor. + * + * Get the color used for the label on a given output (monitor). + */ void mate_rr_labeler_get_color_for_output (MateRRLabeler *labeler, MateRROutputInfo *output, GdkColor *color_out) { |