gtk2/gtk/gtkspinner.c

292 lines
7.8 KiB
C
Raw Normal View History

/* GTK - The GIMP Toolkit
*
* Copyright (C) 2007 John Stowers, Neil Jagdish Patel.
* Copyright (C) 2009 Bastien Nocera, David Zeuthen
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
2012-02-27 13:01:10 +00:00
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Code adapted from egg-spinner
* by Christian Hergert <christian.hergert@gmail.com>
*/
/*
* Modified by the GTK+ Team and others 2007. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include "gtkspinner.h"
#include "gtkimage.h"
#include "gtkintl.h"
#include "gtkprivate.h"
#include "gtkcssnodeprivate.h"
#include "gtkwidgetprivate.h"
2017-05-08 08:56:05 +00:00
#include "gtkcssnumbervalueprivate.h"
#include "gtkrendericonprivate.h"
2009-10-14 17:25:23 +00:00
/**
* GtkSpinner:
2009-10-14 17:25:23 +00:00
*
* A `GtkSpinner` widget displays an icon-size spinning animation.
2021-03-01 06:34:17 +00:00
*
* It is often used as an alternative to a [class@Gtk.ProgressBar]
* for displaying indefinite activity, instead of actual progress.
2009-10-14 17:25:23 +00:00
*
* ![An example GtkSpinner](spinner.png)
*
* To start the animation, use [method@Gtk.Spinner.start], to stop it
* use [method@Gtk.Spinner.stop].
*
* # CSS nodes
*
* `GtkSpinner` has a single CSS node with the name spinner.
* When the animation is active, the :checked pseudoclass is
* added to this node.
2009-10-14 17:25:23 +00:00
*/
2019-05-26 22:50:49 +00:00
typedef struct _GtkSpinnerClass GtkSpinnerClass;
struct _GtkSpinner
{
GtkWidget parent;
};
struct _GtkSpinnerClass
{
GtkWidgetClass parent_class;
};
2009-10-14 17:25:23 +00:00
enum {
PROP_0,
PROP_SPINNING
};
G_DEFINE_TYPE (GtkSpinner, gtk_spinner, GTK_TYPE_WIDGET)
2017-05-08 08:56:05 +00:00
#define DEFAULT_SIZE 16
static void
gtk_spinner_measure (GtkWidget *widget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline)
{
2017-05-08 08:56:05 +00:00
double min_size;
GtkCssStyle *style;
style = gtk_css_node_get_style (gtk_widget_get_css_node (widget));
if (orientation == GTK_ORIENTATION_HORIZONTAL)
min_size = _gtk_css_number_value_get (style->size->min_width, 100);
else
min_size = _gtk_css_number_value_get (style->size->min_height, 100);
2017-05-08 08:56:05 +00:00
if (min_size > 0.0)
*minimum = *natural = min_size;
else
*minimum = *natural = DEFAULT_SIZE;
}
2016-11-15 06:25:13 +00:00
static void
gtk_spinner_snapshot (GtkWidget *widget,
GtkSnapshot *snapshot)
{
2017-05-08 08:56:05 +00:00
GtkCssStyle *style = gtk_css_node_get_style (gtk_widget_get_css_node (widget));
gtk_css_style_snapshot_icon (style,
snapshot,
gtk_widget_get_width (widget),
gtk_widget_get_height (widget));
}
static void
gtk_spinner_css_changed (GtkWidget *widget,
GtkCssStyleChange *change)
{
GTK_WIDGET_CLASS (gtk_spinner_parent_class)->css_changed (widget, change);
if (change == NULL ||
gtk_css_style_change_affects (change, GTK_CSS_AFFECTS_ICON_SIZE))
{
gtk_widget_queue_resize (widget);
}
else if (gtk_css_style_change_affects (change, GTK_CSS_AFFECTS_ICON_TEXTURE |
GTK_CSS_AFFECTS_ICON_REDRAW))
{
gtk_widget_queue_draw (widget);
}
}
/**
* gtk_spinner_get_spinning: (attributes org.gtk.Method.get_property=spinning)
* @spinner: a `GtkSpinner`
*
* Returns whether the spinner is spinning.
*
* Returns: %TRUE if the spinner is active
*/
gboolean
gtk_spinner_get_spinning (GtkSpinner *spinner)
{
g_return_val_if_fail (GTK_IS_SPINNER (spinner), FALSE);
return (gtk_widget_get_state_flags ((GtkWidget *)spinner) & GTK_STATE_FLAG_CHECKED) > 0;
}
/**
* gtk_spinner_set_spinning: (attributes org.gtk.Method.set_property=spinning)
* @spinner: a `GtkSpinner`
* @spinning: whether the spinner should be spinning
*
* Sets the activity of the spinner.
*/
void
gtk_spinner_set_spinning (GtkSpinner *spinner,
gboolean spinning)
{
g_return_if_fail (GTK_IS_SPINNER (spinner));
spinning = !!spinning;
if (spinning != gtk_spinner_get_spinning (spinner))
{
g_object_notify (G_OBJECT (spinner), "spinning");
if (spinning)
gtk_widget_set_state_flags (GTK_WIDGET (spinner),
GTK_STATE_FLAG_CHECKED, FALSE);
else
gtk_widget_unset_state_flags (GTK_WIDGET (spinner),
GTK_STATE_FLAG_CHECKED);
}
}
static void
gtk_spinner_get_property (GObject *object,
guint param_id,
GValue *value,
GParamSpec *pspec)
{
switch (param_id)
{
case PROP_SPINNING:
g_value_set_boolean (value, gtk_spinner_get_spinning (GTK_SPINNER (object)));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
}
}
static void
gtk_spinner_set_property (GObject *object,
guint param_id,
const GValue *value,
GParamSpec *pspec)
{
switch (param_id)
{
case PROP_SPINNING:
gtk_spinner_set_spinning (GTK_SPINNER (object), g_value_get_boolean (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
}
}
static void
gtk_spinner_class_init (GtkSpinnerClass *klass)
{
GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
gobject_class = G_OBJECT_CLASS(klass);
gobject_class->get_property = gtk_spinner_get_property;
gobject_class->set_property = gtk_spinner_set_property;
widget_class = GTK_WIDGET_CLASS(klass);
2016-11-15 06:25:13 +00:00
widget_class->snapshot = gtk_spinner_snapshot;
widget_class->measure = gtk_spinner_measure;
widget_class->css_changed = gtk_spinner_css_changed;
/**
* GtkSpinner:spinning: (attributes org.gtk.Property.get=gtk_spinner_get_spinning org.gtk.Property.set=gtk_spinner_set_spinning)
*
* Whether the spinner is spinning
*/
g_object_class_install_property (gobject_class,
PROP_SPINNING,
g_param_spec_boolean ("spinning",
P_("Spinning"),
P_("Whether the spinner is spinning"),
FALSE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
gtk_widget_class_set_css_name (widget_class, I_("spinner"));
}
static void
gtk_spinner_init (GtkSpinner *spinner)
{
}
/**
2009-10-14 17:25:23 +00:00
* gtk_spinner_new:
*
* Returns a new spinner widget. Not yet started.
*
* Returns: a new `GtkSpinner`
*/
GtkWidget *
gtk_spinner_new (void)
{
return g_object_new (GTK_TYPE_SPINNER, NULL);
}
/**
2009-10-14 17:25:23 +00:00
* gtk_spinner_start:
* @spinner: a `GtkSpinner`
*
2009-10-14 17:25:23 +00:00
* Starts the animation of the spinner.
*/
void
gtk_spinner_start (GtkSpinner *spinner)
{
g_return_if_fail (GTK_IS_SPINNER (spinner));
gtk_spinner_set_spinning (spinner, TRUE);
}
/**
2009-10-14 17:25:23 +00:00
* gtk_spinner_stop:
* @spinner: a `GtkSpinner`
*
2009-10-14 17:25:23 +00:00
* Stops the animation of the spinner.
*/
void
gtk_spinner_stop (GtkSpinner *spinner)
{
g_return_if_fail (GTK_IS_SPINNER (spinner));
gtk_spinner_set_spinning (spinner, FALSE);
}