[gtk+/wip/baedert/gtkimageview] Moar docs
- From: Timm Bäder <baedert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/wip/baedert/gtkimageview] Moar docs
- Date: Mon, 8 Feb 2016 19:12:24 +0000 (UTC)
commit f3df0da19c8b016d7c604db712a26b5a411f58f0
Author: Timm Bäder <mail baedert org>
Date: Mon Feb 8 20:10:33 2016 +0100
Moar docs
gtk/gtkimageview.c | 73 +++++++++++++++++++++++++++++++++++++++++++--------
1 files changed, 61 insertions(+), 12 deletions(-)
---
diff --git a/gtk/gtkimageview.c b/gtk/gtkimageview.c
index a432292..5289127 100644
--- a/gtk/gtkimageview.c
+++ b/gtk/gtkimageview.c
@@ -1217,13 +1217,13 @@ gtk_image_view_set_vscroll_policy (GtkImageView *image_view,
* Sets the value of the #scale property. This will cause the
* #scale-set property to be set to #FALSE as well
*
- * If #fit-allocation is #TRUE, it will be set to #FALSE, and @image_view
+ * If #GtkImageView:fit-allocation is %TRUE, it will be set to #FALSE, and @image_view
* will be resized to the image's current size, taking the new scale into
* account.
*
- * If #transitions-enabled is set to #TRUE, the internal scale value will be
+ * If #GtkImageView:transitions-enabled is set to #TRUE, the internal scale value will be
* interpolated between the old and the new scale, #gtk_image_view_get_scale
- * will report the one passed to #gtk_image_view_set_scale however.
+ * will report the one passed to gtk_image_view_set_scale() however.
*
* Since: 3.20
*/
@@ -1384,8 +1384,8 @@ gtk_image_view_get_angle (GtkImageView *image_view)
* @image_view: A #GtkImageView instance
* @snap_angle: The new value of the #snap-angle property
*
- * Setting #snap-angle to #TRUE will cause @image_view's angle to
- * be snapped to 90° steps. Setting the #angle property will cause it to
+ * Setting #snap-angle to %TRUE will cause @image_view's angle to
+ * be snapped to 90° steps. Setting the #GtkImageView:angle property will cause it to
* be set to the closest 90° step, so e.g. using an angle of 40 will result
* in an angle of 0, using 240 will result in 270, etc.
*
@@ -1420,7 +1420,7 @@ gtk_image_view_set_snap_angle (GtkImageView *image_view,
* gtk_image_view_get_snap_angle:
* @image_view: A #GtkImageView instance
*
- * Returns: The current value of the #snap-angle property.
+ * Returns: The current value of the #GtkImageView:snap-angle property.
*
* Since: 3.20
*/
@@ -1445,9 +1445,9 @@ gtk_image_view_get_snap_angle (GtkImageView *image_view)
* scaled up.
*
* Setting #fit-allocation will have the side effect of setting
- * #scale-set set to #FALSE, thus giving the #GtkImageView the control
+ * #scale-set set to %FALSE, thus giving the #GtkImageView the control
* over the image's scale. Additionally, if the new #fit-allocation
- * value is #FALSE, the scale will be reset to 1.0 and the #GtkImageView
+ * value is %FALSE, the scale will be reset to 1.0 and the #GtkImageView
* will be resized to take at least the image's real size.
*
* Since: 3.20
@@ -1502,6 +1502,16 @@ gtk_image_view_get_fit_allocation (GtkImageView *image_view)
return priv->fit_allocation;
}
+/**
+ * gtk_image_view_get_rotatable:
+ * @image_view: A #GtkImageView instance
+ * @rotatable: The new value of the rotatable property
+ *
+ * Sets the value of the #rotatable property to @rotatable. This controls whether
+ * the user can change the angle of the displayed image using a two-finger gesture.
+ *
+ * Since: 3.20
+ */
void
gtk_image_view_set_rotatable (GtkImageView *image_view,
gboolean rotatable)
@@ -1520,6 +1530,14 @@ gtk_image_view_set_rotatable (GtkImageView *image_view,
}
}
+/**
+ * gtk_image_view_get_rotatable:
+ * @image_view: A #GtkImageView instance
+ *
+ * Returns: The current value of the #rotatable property
+ *
+ * Since: 3.20
+ */
gboolean
gtk_image_view_get_rotatable (GtkImageView *image_view)
{
@@ -1529,8 +1547,16 @@ gtk_image_view_get_rotatable (GtkImageView *image_view)
return priv->rotatable;
}
-
-
+/**
+ * gtk_image_view_set_zoomable:
+ * @image_view: A #GtkImageView instance
+ * @zoomable: The new value of the #zoomable property
+ *
+ * Sets the new value of the #zoomable property. This controls whether the user can
+ * change the #GtkImageView:scale property using a two-finger gesture.
+ *
+ * Since: 3.20
+ */
void
gtk_image_view_set_zoomable (GtkImageView *image_view,
gboolean zoomable)
@@ -1549,6 +1575,14 @@ gtk_image_view_set_zoomable (GtkImageView *image_view,
}
}
+/**
+ * gtk_image_view_get_zoomable:
+ * @image_view: A #GtkImageView instance
+ *
+ * Returns: The current value of the #GtkImageView:zoomable property.
+ *
+ * Since: 3.20
+ */
gboolean
gtk_image_view_get_zoomable (GtkImageView *image_view)
{
@@ -1558,8 +1592,15 @@ gtk_image_view_get_zoomable (GtkImageView *image_view)
return priv->zoomable;
}
-
-
+/**
+ * gtk_image_view_set_transiions_enabled:
+ * @image_view: A #GtkImageView instance
+ * @transitions_enabled: The new value of the #transitions-enabled property
+ *
+ * Sets the new value of the #GtkImageView:transitions-enabled property.
+ *
+ * Since: 3.20
+ */
void
gtk_image_view_set_transitions_enabled (GtkImageView *image_view,
gboolean transitions_enabled)
@@ -1577,6 +1618,14 @@ gtk_image_view_set_transitions_enabled (GtkImageView *image_view,
}
}
+/**
+ * gtk_image_view_get_transitions_enabled:
+ * @image_view: A #GtkImageView instance
+ *
+ * Returns the current value of the #GtkImageView:transitions-enabled property.
+ *
+ * Since: 3.20
+ */
gboolean
gtk_image_view_get_transitions_enabled (GtkImageView *image_view)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]