Commit aa229145 authored by Ell's avatar Ell

libgimpwidgets: add GimpBusyBox

GimpBusyBox is used to show a message indicating an operation is in
progress.  It's basically just a spinner and a label, with some
styling.

We're going to use it both in app/ and in a plug-in.
parent 957cdc23
......@@ -132,6 +132,10 @@
<title>Index of new symbols in GIMP 2.10</title>
<xi:include href="xml/api-index-2.10.xml"><xi:fallback /></xi:include>
</index>
<index role="2.10.4" id="api-index-2-10-4">
<title>Index of new symbols in GIMP 2.10.4</title>
<xi:include href="xml/api-index-2.10.4.xml"><xi:fallback /></xi:include>
</index>
<index role="deprecated" id="api-index-deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
......
......@@ -17,6 +17,24 @@ GIMP_IS_BROWSER_CLASS
GIMP_BROWSER_GET_CLASS
</SECTION>
<SECTION>
<FILE>gimpbusybox</FILE>
<TITLE>GimpBusyBox</TITLE>
GimpBusyBox
gimp_busy_box_new
gimp_busy_box_set_message
gimp_busy_box_get_message
<SUBSECTION Standard>
GIMP_BUSY_BOX
GIMP_IS_BUSY_BOX
GIMP_TYPE_BUSY_BOX
gimp_busy_box_get_type
GimpBusyBoxClass
GIMP_BUSY_BOX_CLASS
GIMP_IS_BUSY_BOX_CLASS
GIMP_BUSY_BOX_GET_CLASS
</SECTION>
<SECTION>
<FILE>gimpbutton</FILE>
<TITLE>GimpButton</TITLE>
......
......@@ -4,6 +4,7 @@
#include <libgimpwidgets/gimpcontroller.h>
gimp_browser_get_type
gimp_busy_box_get_type
gimp_button_get_type
gimp_cell_renderer_color_get_type
gimp_cell_renderer_toggle_get_type
......
......@@ -76,6 +76,8 @@ lib_LTLIBRARIES = libgimpwidgets-@GIMP_API_VERSION@.la
libgimpwidgets_sources = \
gimpbrowser.c \
gimpbrowser.h \
gimpbusybox.c \
gimpbusybox.h \
gimpbutton.c \
gimpbutton.h \
gimpcairo-utils.c \
......
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpbusybox.c
* Copyright (C) 2018 Ell
*
* 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 3 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
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <gegl.h>
#include <gtk/gtk.h>
#include "gimpwidgetstypes.h"
#include "gimp3migration.h"
#include "gimpbusybox.h"
#include "gimpwidgetsutils.h"
/**
* SECTION: gimpbusybox
* @title: GimpBusyBox
* @short_description: A widget indicating an ongoing operation
*
* #GimpBusyBox displays a styled message, providing indication of
* an ongoing operation.
**/
enum
{
PROP_0,
PROP_MESSAGE
};
struct _GimpBusyBoxPrivate
{
GtkLabel *label;
};
/* local function prototypes */
static void gimp_busy_box_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void gimp_busy_box_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
G_DEFINE_TYPE (GimpBusyBox, gimp_busy_box, GTK_TYPE_ALIGNMENT)
#define parent_class gimp_busy_box_parent_class
/* private functions */
static void
gimp_busy_box_class_init (GimpBusyBoxClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->set_property = gimp_busy_box_set_property;
object_class->get_property = gimp_busy_box_get_property;
/**
* GimpBusyBox:message:
*
* Specifies the displayed message.
*
* Since: 2.10.4
*/
g_object_class_install_property (object_class, PROP_MESSAGE,
g_param_spec_string ("message",
NULL, NULL,
NULL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
g_type_class_add_private (klass, sizeof (GimpBusyBoxPrivate));
}
static void
gimp_busy_box_init (GimpBusyBox *box)
{
GtkWidget *hbox;
GtkWidget *spinner;
GtkWidget *label;
box->priv = G_TYPE_INSTANCE_GET_PRIVATE (box,
GIMP_TYPE_BUSY_BOX,
GimpBusyBoxPrivate);
gtk_alignment_set (GTK_ALIGNMENT (box), 0.5, 0.5, 0.0, 0.0);
/* the main hbox */
hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 8);
gtk_container_add (GTK_CONTAINER (box), hbox);
gtk_widget_show (hbox);
/* the spinner */
spinner = gtk_spinner_new ();
gtk_widget_set_size_request (spinner, 16, 16);
gtk_spinner_start (GTK_SPINNER (spinner));
gtk_box_pack_start (GTK_BOX (hbox), spinner, FALSE, FALSE, 0);
gtk_widget_show (spinner);
/* the label */
label = gtk_label_new (NULL);
box->priv->label = GTK_LABEL (label);
gimp_label_set_attributes (GTK_LABEL (label),
PANGO_ATTR_STYLE, PANGO_STYLE_ITALIC,
-1);
gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
gtk_widget_show (label);
}
static void
gimp_busy_box_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GimpBusyBox *box = GIMP_BUSY_BOX (object);
switch (property_id)
{
case PROP_MESSAGE:
gtk_label_set_text (box->priv->label, g_value_get_string (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_busy_box_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GimpBusyBox *box = GIMP_BUSY_BOX (object);
switch (property_id)
{
case PROP_MESSAGE:
g_value_set_string (value, gtk_label_get_text (box->priv->label));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
/* public functions */
/**
* gimp_busy_box_new:
* @message: (allow-none): the displayed message, or %NULL
*
* Creates a new #GimpBusyBox widget.
*
* Returns: A pointer to the new #GimpBusyBox widget.
*
* Since: 2.10.4
**/
GtkWidget *
gimp_busy_box_new (const gchar *message)
{
if (message == NULL)
message = "";
return g_object_new (GIMP_TYPE_BUSY_BOX,
"message", message,
NULL);
}
/**
* gimp_busy_box_set_message:
* @box: a #GimpBusyBox
* @message: the displayed message
*
* Sets the displayed message og @box to @message.
*
* Since: 2.10.4
**/
void
gimp_busy_box_set_message (GimpBusyBox *box,
const gchar *message)
{
g_return_if_fail (GIMP_IS_BUSY_BOX (box));
g_return_if_fail (message != NULL);
g_object_set (box,
"message", message,
NULL);
}
/**
* gimp_busy_box_get_message:
* @box: a #GimpBusyBox
*
* Returns the displayed message of @box.
*
* Returns: The displayed message.
*
* Since: 2.10.4
**/
const gchar *
gimp_busy_box_get_message (GimpBusyBox *box)
{
g_return_val_if_fail (GIMP_IS_BUSY_BOX (box), NULL);
return gtk_label_get_text (box->priv->label);
}
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpbusybox.h
* Copyright (C) 2018 Ell
*
* 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 3 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
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*/
#if !defined (__GIMP_WIDGETS_H_INSIDE__) && !defined (GIMP_WIDGETS_COMPILATION)
#error "Only <libgimpwidgets/gimpwidgets.h> can be included directly."
#endif
#ifndef __GIMP_BUSY_BOX_H__
#define __GIMP_BUSY_BOX_H__
G_BEGIN_DECLS
#define GIMP_TYPE_BUSY_BOX (gimp_busy_box_get_type ())
#define GIMP_BUSY_BOX(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_BUSY_BOX, GimpBusyBox))
#define GIMP_BUSY_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_BUSY_BOX, GimpBusyBoxClass))
#define GIMP_IS_BUSY_BOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_BUSY_BOX))
#define GIMP_IS_BUSY_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_BUSY_BOX))
#define GIMP_BUSY_BOX_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_BUSY_BOX, GimpBusyBoxClass))
typedef struct _GimpBusyBoxPrivate GimpBusyBoxPrivate;
typedef struct _GimpBusyBoxClass GimpBusyBoxClass;
struct _GimpBusyBox
{
GtkAlignment parent_instance;
GimpBusyBoxPrivate *priv;
};
struct _GimpBusyBoxClass
{
GtkAlignmentClass parent_class;
/* Padding for future expansion */
void (* _gimp_reserved1) (void);
void (* _gimp_reserved2) (void);
void (* _gimp_reserved3) (void);
void (* _gimp_reserved4) (void);
};
GType gimp_busy_box_get_type (void) G_GNUC_CONST;
GtkWidget * gimp_busy_box_new (const gchar *message);
void gimp_busy_box_set_message (GimpBusyBox *box,
const gchar *message);
const gchar * gimp_busy_box_get_message (GimpBusyBox *box);
G_END_DECLS
#endif /* __GIMP_BUSY_BOX_H__ */
......@@ -9,6 +9,10 @@ EXPORTS
gimp_browser_new
gimp_browser_set_widget
gimp_browser_show_message
gimp_busy_box_get_message
gimp_busy_box_get_type
gimp_busy_box_new
gimp_busy_box_set_message
gimp_button_extended_clicked
gimp_button_get_type
gimp_button_new
......
......@@ -27,6 +27,7 @@
#include <libgimpwidgets/gimpwidgetstypes.h>
#include <libgimpwidgets/gimpbrowser.h>
#include <libgimpwidgets/gimpbusybox.h>
#include <libgimpwidgets/gimpbutton.h>
#include <libgimpwidgets/gimpcairo-utils.h>
#include <libgimpwidgets/gimpcellrenderercolor.h>
......
......@@ -31,6 +31,7 @@ G_BEGIN_DECLS
typedef struct _GimpBrowser GimpBrowser;
typedef struct _GimpBusyBox GimpBusyBox;
typedef struct _GimpButton GimpButton;
typedef struct _GimpCellRendererColor GimpCellRendererColor;
typedef struct _GimpCellRendererToggle GimpCellRendererToggle;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment