/**
* gimp_ruler_get_position:
* @ruler: a #GimpRuler
*
* Return value: the current position of the @ruler widget.
*
* Since: GIMP 2.8
**/
gdouble
gimp_ruler_get_position (GimpRuler *ruler)
{
g_return_val_if_fail (GIMP_IS_RULER (ruler), 0.0);
return GIMP_RULER_GET_PRIVATE (ruler)->position;
}
/**
* gimp_ruler_set_range:
* @ruler: a #GimpRuler
* @lower: the lower limit of the ruler
* @upper: the upper limit of the ruler
* @max_size: the maximum size of the ruler used when calculating the space to
* leave for the text
*
* This sets the range of the ruler.
*
* Since: GIMP 2.8
*/
void
gimp_ruler_set_range (GimpRuler *ruler,
gdouble lower,
gdouble upper,
gdouble max_size)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
g_object_freeze_notify (G_OBJECT (ruler));
if (priv->lower != lower)
{
priv->lower = lower;
g_object_notify (G_OBJECT (ruler), "lower");
}
if (priv->upper != upper)
{
priv->upper = upper;
g_object_notify (G_OBJECT (ruler), "upper");
}
if (priv->max_size != max_size)
{
priv->max_size = max_size;
g_object_notify (G_OBJECT (ruler), "max-size");
}
g_object_thaw_notify (G_OBJECT (ruler));
gtk_widget_queue_draw (GTK_WIDGET (ruler));
}
/**
* gimp_ruler_get_unit:
* @ruler: a #GimpRuler
*
* Return value: the unit currently used in the @ruler widget.
*
* Since: GIMP 2.8
**/
GimpUnit
gimp_ruler_get_unit (GimpRuler *ruler)
{
g_return_val_if_fail (GIMP_IS_RULER (ruler), 0);
return GIMP_RULER_GET_PRIVATE (ruler)->unit;
}
/**
* gimp_ruler_set_position:
* @ruler: a #GimpRuler
* @position: the position to set the ruler to
*
* This sets the position of the ruler.
*
* Since: 2.8
*/
void
gimp_ruler_set_position (GimpRuler *ruler,
gdouble position)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
if (priv->position != position)
{
GdkRectangle rect;
gint xdiff, ydiff;
priv->position = position;
g_object_notify (G_OBJECT (ruler), "position");
rect = gimp_ruler_get_pos_rect (ruler, priv->position);
xdiff = rect.x - priv->last_pos_rect.x;
ydiff = rect.y - priv->last_pos_rect.y;
/*
* If the position has changed far enough, queue a redraw immediately.
* Otherwise, we only queue a redraw in a low priority idle handler, to
* allow for other things (like updating the canvas) to run.
*
* TODO: This might not be necessary any more in GTK3 with the frame
* clock. Investigate this more after the port to GTK3.
*/
if (priv->last_pos_rect.width != 0 &&
priv->last_pos_rect.height != 0 &&
(ABS (xdiff) > IMMEDIATE_REDRAW_THRESHOLD ||
ABS (ydiff) > IMMEDIATE_REDRAW_THRESHOLD))
{
gimp_ruler_queue_pos_redraw (ruler);
}
else if (! priv->pos_redraw_idle_id)
{
priv->pos_redraw_idle_id =
g_idle_add_full (G_PRIORITY_LOW,
gimp_ruler_idle_queue_pos_redraw,
ruler, NULL);
}
}
}
/**
* gimp_ruler_set_position:
* @ruler: a #GimpRuler
* @position: the position to set the ruler to
*
* This sets the position of the ruler.
*
* Since: GIMP 2.8
*/
void
gimp_ruler_set_position (GimpRuler *ruler,
gdouble position)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
if (priv->position != position)
{
priv->position = position;
g_object_notify (G_OBJECT (ruler), "position");
gimp_ruler_draw_pos (ruler);
}
}
/**
* gimp_ruler_set_unit:
* @ruler: a #GimpRuler
* @unit: the #GimpUnit to set the ruler to
*
* This sets the unit of the ruler.
*
* Since: GIMP 2.8
*/
void
gimp_ruler_set_unit (GimpRuler *ruler,
GimpUnit unit)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
if (priv->unit != unit)
{
priv->unit = unit;
g_object_notify (G_OBJECT (ruler), "unit");
gtk_widget_queue_draw (GTK_WIDGET (ruler));
}
}
/**
* gimp_ruler_get_range:
* @ruler: a #GimpRuler
* @lower: location to store lower limit of the ruler, or %NULL
* @upper: location to store upper limit of the ruler, or %NULL
* @max_size: location to store the maximum size of the ruler used when
* calculating the space to leave for the text, or %NULL.
*
* Retrieves values indicating the range and current position of a #GimpRuler.
* See gimp_ruler_set_range().
*
* Since: GIMP 2.8
**/
void
gimp_ruler_get_range (GimpRuler *ruler,
gdouble *lower,
gdouble *upper,
gdouble *max_size)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
if (lower)
*lower = priv->lower;
if (upper)
*upper = priv->upper;
if (max_size)
*max_size = priv->max_size;
}
/**
* gimp_ruler_remove_track_widget:
* @ruler: a #GimpRuler
* @widget: the track widget to remove
*
* Removes a previously added track widget from the ruler. See
* gimp_ruler_add_track_widget().
*
* Since: GIMP 2.8
*/
void
gimp_ruler_remove_track_widget (GimpRuler *ruler,
GtkWidget *widget)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
g_return_if_fail (GTK_IS_WIDGET (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
g_return_if_fail (g_list_find (priv->track_widgets, widget) != NULL);
priv->track_widgets = g_list_remove (priv->track_widgets, widget);
g_signal_handlers_disconnect_by_func (widget,
gimp_ruler_track_widget_motion_notify,
ruler);
g_signal_handlers_disconnect_by_func (widget,
gimp_ruler_remove_track_widget,
ruler);
}
/**
* gimp_ruler_add_track_widget:
* @ruler: a #GimpRuler
* @widget: the track widget to add
*
* Adds a "track widget" to the ruler. The ruler will connect to
* GtkWidget:motion-notify-event: on the track widget and update its
* position marker accordingly. The marker is correctly updated also
* for the track widget's children, regardless of whether they are
* ordinary children of off-screen children.
*
* Since: GIMP 2.8
*/
void
gimp_ruler_add_track_widget (GimpRuler *ruler,
GtkWidget *widget)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
g_return_if_fail (GTK_IS_WIDGET (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
g_return_if_fail (g_list_find (priv->track_widgets, widget) == NULL);
priv->track_widgets = g_list_prepend (priv->track_widgets, widget);
g_signal_connect (widget, "motion-notify-event",
G_CALLBACK (gimp_ruler_track_widget_motion_notify),
ruler);
g_signal_connect_swapped (widget, "destroy",
G_CALLBACK (gimp_ruler_remove_track_widget),
ruler);
}
/**
* gimp_ruler_set_position:
* @ruler: a #GimpRuler
* @position: the position to set the ruler to
*
* This sets the position of the ruler.
*
* Since: 2.8
*/
void
gimp_ruler_set_position (GimpRuler *ruler,
gdouble position)
{
GimpRulerPrivate *priv;
g_return_if_fail (GIMP_IS_RULER (ruler));
priv = GIMP_RULER_GET_PRIVATE (ruler);
if (priv->position != position)
{
gdouble old_pos = priv->position;
priv->position = position;
g_object_notify (G_OBJECT (ruler), "position");
{
GdkRectangle rect;
rect = gimp_ruler_get_pos_rect (ruler, old_pos);
gtk_widget_queue_draw_area (GTK_WIDGET(ruler),
rect.x,
rect.y,
rect.width,
rect.height);
rect = gimp_ruler_get_pos_rect (ruler, position);
gtk_widget_queue_draw_area (GTK_WIDGET(ruler),
rect.x,
rect.y,
rect.width,
rect.height);
}
}
}
