PIKApp/libpikawidgets/pikabusybox.c

233 lines
5.8 KiB
C
Raw Permalink Normal View History

2023-09-26 00:35:21 +02:00
/* LIBPIKA - The PIKA Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* pikabusybox.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
* <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <gegl.h>
#include <gtk/gtk.h>
#include "libpikabase/pikabase.h"
#include "pikawidgetstypes.h"
#include "pikabusybox.h"
#include "pikawidgetsutils.h"
/**
* SECTION: pikabusybox
* @title: PikaBusyBox
* @short_description: A widget indicating an ongoing operation
*
* #PikaBusyBox displays a styled message, providing indication of
* an ongoing operation.
**/
enum
{
PROP_0,
PROP_MESSAGE
};
struct _PikaBusyBoxPrivate
{
GtkLabel *label;
};
/* local function prototypes */
static void pika_busy_box_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void pika_busy_box_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
G_DEFINE_TYPE_WITH_PRIVATE (PikaBusyBox, pika_busy_box, GTK_TYPE_BOX)
#define parent_class pika_busy_box_parent_class
/* private functions */
static void
pika_busy_box_class_init (PikaBusyBoxClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->set_property = pika_busy_box_set_property;
object_class->get_property = pika_busy_box_get_property;
/**
* PikaBusyBox:message:
*
* Specifies the displayed message.
*
* Since: 2.10.4
**/
g_object_class_install_property (object_class, PROP_MESSAGE,
g_param_spec_string ("message",
"Message",
"The message to display",
NULL,
PIKA_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
}
static void
pika_busy_box_init (PikaBusyBox *box)
{
GtkWidget *spinner;
GtkWidget *label;
box->priv = pika_busy_box_get_instance_private (box);
gtk_widget_set_halign (GTK_WIDGET (box), GTK_ALIGN_CENTER);
gtk_widget_set_valign (GTK_WIDGET (box), GTK_ALIGN_CENTER);
gtk_box_set_spacing (GTK_BOX (box), 8);
/* the spinner */
spinner = gtk_spinner_new ();
gtk_spinner_start (GTK_SPINNER (spinner));
gtk_box_pack_start (GTK_BOX (box), spinner, FALSE, FALSE, 0);
gtk_widget_show (spinner);
/* the label */
label = gtk_label_new (NULL);
box->priv->label = GTK_LABEL (label);
pika_label_set_attributes (GTK_LABEL (label),
PANGO_ATTR_STYLE, PANGO_STYLE_ITALIC,
-1);
gtk_box_pack_start (GTK_BOX (box), label, FALSE, FALSE, 0);
gtk_widget_show (label);
}
static void
pika_busy_box_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
PikaBusyBox *box = PIKA_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
pika_busy_box_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
PikaBusyBox *box = PIKA_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 */
/**
* pika_busy_box_new:
* @message: (allow-none): the displayed message, or %NULL
*
* Creates a new #PikaBusyBox widget.
*
* Returns: A pointer to the new #PikaBusyBox widget.
*
* Since: 2.10.4
**/
GtkWidget *
pika_busy_box_new (const gchar *message)
{
if (message == NULL)
message = "";
return g_object_new (PIKA_TYPE_BUSY_BOX,
"message", message,
NULL);
}
/**
* pika_busy_box_set_message:
* @box: a #PikaBusyBox
* @message: the displayed message
*
* Sets the displayed message og @box to @message.
*
* Since: 2.10.4
**/
void
pika_busy_box_set_message (PikaBusyBox *box,
const gchar *message)
{
g_return_if_fail (PIKA_IS_BUSY_BOX (box));
g_return_if_fail (message != NULL);
g_object_set (box,
"message", message,
NULL);
}
/**
* pika_busy_box_get_message:
* @box: a #PikaBusyBox
*
* Returns the displayed message of @box.
*
* Returns: The displayed message.
*
* Since: 2.10.4
**/
const gchar *
pika_busy_box_get_message (PikaBusyBox *box)
{
g_return_val_if_fail (PIKA_IS_BUSY_BOX (box), NULL);
return gtk_label_get_text (box->priv->label);
}