diff options
Diffstat (limited to 'widgets/src/SpokeSelector.c')
| -rw-r--r-- | widgets/src/SpokeSelector.c | 251 |
1 files changed, 251 insertions, 0 deletions
diff --git a/widgets/src/SpokeSelector.c b/widgets/src/SpokeSelector.c new file mode 100644 index 000000000..7f0279405 --- /dev/null +++ b/widgets/src/SpokeSelector.c @@ -0,0 +1,251 @@ +/* + * Copyright (C) 2011 Red Hat, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + * Author: Chris Lumens <clumens@redhat.com> + */ + +#include "SpokeSelector.h" +#include "intl.h" + +/** + * SECTION: SpokeSelector + * @title: AnacondaSpokeSelector + * @short_description: A graphical way to enter a configuration spoke + * + * A #AnacondaSpokeSelector is a widget that is associated with a Spoke and + * is packed into a grid on a Hub. A Spoke allows the user to configure one + * piece of system, and the associated selector both displays the current + * configuration and allows for a place to click to do further configuration. + * + * Some Spokes can have their initial configuration guessed, while others + * (specifically storage) requires the user to do something. For those that + * the user has not entered, the selector may be set as incomplete. See + * #anaconda_spoke_selector_get_incomplete and #anaconda_spoke_selector_set_incomplete. + * + * As a #AnacondaSpokeSelector is a subclass of a #GtkEventBox, any signals + * may be caught. However ::button-press-event is the most important one and + * should be how control is transferred to a Spoke. + */ + +enum { + PROP_ICON = 1, + PROP_STATUS, + PROP_TITLE, +}; + +#define DEFAULT_ICON "gtk-missing-image" +#define DEFAULT_STATUS "None" +#define DEFAULT_TITLE "New Selector" + +struct _AnacondaSpokeSelectorPrivate { + gboolean is_incomplete; + GtkWidget *grid; + GtkWidget *icon; + GtkWidget *title_label; + GtkWidget *status_label; +}; + +G_DEFINE_TYPE(AnacondaSpokeSelector, anaconda_spoke_selector, GTK_TYPE_EVENT_BOX) + +static void anaconda_spoke_selector_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec); +static void anaconda_spoke_selector_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec); + +static void anaconda_spoke_selector_class_init(AnacondaSpokeSelectorClass *klass) { + GObjectClass *object_class = G_OBJECT_CLASS(klass); + + object_class->set_property = anaconda_spoke_selector_set_property; + object_class->get_property = anaconda_spoke_selector_get_property; + + /** + * AnacondaSpokeSelector:icon: + * + * The :icon string is the standard icon name for an icon to display + * beside this spoke's :title. It is strongly suggested that one of the + * "-symbolic" icons be used, as that is consistent with the style we + * are going for. + * + * Since: 1.0 + */ + g_object_class_install_property(object_class, + PROP_ICON, + g_param_spec_string("icon", + P_("Icon"), + P_("Icon to appear next to the title"), + DEFAULT_ICON, + G_PARAM_READWRITE)); + + /** + * AnacondaSpokeSelector:status: + * + * The :status string is text displayed underneath the spoke's :title and + * also beside the :icon. This text very briefly describes what has been + * selected on the spoke associated with this selector. For instance, it + * might be set up to "English" for a language-related spoke. + * + * Since: 1.0 + */ + g_object_class_install_property(object_class, + PROP_STATUS, + g_param_spec_string("status", + P_("Status"), + P_("Status display"), + DEFAULT_STATUS, + G_PARAM_READWRITE)); + + /** + * AnacondaSpokeSelector:title: + * + * The :title of this selector, which will be displayed large and bold + * beside the :icon. + * + * Since: 1.0 + */ + g_object_class_install_property(object_class, + PROP_TITLE, + g_param_spec_string("title", + P_("Title"), + P_("The title of the spoke selector"), + DEFAULT_TITLE, + G_PARAM_READWRITE)); + + g_type_class_add_private(object_class, sizeof(AnacondaSpokeSelectorPrivate)); +} + +/** + * anaconda_spoke_selector_new: + * + * Creates a new #AnacondaSpokeSelector, which is a selectable display for a + * single spoke of an Anaconda hub. Many spokes may be put together into a + * grid, displaying everything that a user needs to do in one place. + * + * Returns: A new #AnacondaSpokeSelector. + */ +GtkWidget *anaconda_spoke_selector_new() { + return g_object_new(ANACONDA_TYPE_SPOKE_SELECTOR, NULL); +} + +static void anaconda_spoke_selector_init(AnacondaSpokeSelector *spoke) { + char *markup; + + spoke->priv = G_TYPE_INSTANCE_GET_PRIVATE(spoke, + ANACONDA_TYPE_SPOKE_SELECTOR, + AnacondaSpokeSelectorPrivate); + + /* Set property defaults. */ + spoke->priv->is_incomplete = FALSE; + + /* Create the grid. */ + spoke->priv->grid = gtk_grid_new(); + gtk_grid_set_column_spacing(GTK_GRID(spoke->priv->grid), 6); + + /* Create the icon. */ + spoke->priv->icon = gtk_image_new_from_stock(DEFAULT_ICON, GTK_ICON_SIZE_DIALOG); + + /* Create the title label. */ + spoke->priv->title_label = gtk_label_new(NULL); + markup = g_markup_printf_escaped("<span weight='bold'>%s</span>", _(DEFAULT_TITLE)); + gtk_label_set_markup(GTK_LABEL(spoke->priv->title_label), markup); + gtk_misc_set_alignment(GTK_MISC(spoke->priv->title_label), 0, 0); + g_free(markup); + + /* Create the status label. */ + spoke->priv->status_label = gtk_label_new(NULL); + markup = g_markup_printf_escaped("<span style='italic'>%s</span>", _(DEFAULT_STATUS)); + gtk_label_set_markup(GTK_LABEL(spoke->priv->status_label), markup); + gtk_misc_set_alignment(GTK_MISC(spoke->priv->status_label), 0, 0); + g_free(markup); + + /* Add everything to the grid, add the grid to the widget. */ + gtk_grid_attach(GTK_GRID(spoke->priv->grid), spoke->priv->icon, 0, 0, 1, 2); + gtk_grid_attach(GTK_GRID(spoke->priv->grid), spoke->priv->title_label, 1, 0, 1, 1); + gtk_grid_attach(GTK_GRID(spoke->priv->grid), spoke->priv->status_label, 1, 1, 1, 1); + + gtk_container_add(GTK_CONTAINER(spoke), spoke->priv->grid); +} + +static void anaconda_spoke_selector_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { + AnacondaSpokeSelector *widget = ANACONDA_SPOKE_SELECTOR(object); + AnacondaSpokeSelectorPrivate *priv = widget->priv; + + switch(prop_id) { + case PROP_ICON: + g_value_set_object (value, (GObject *)priv->icon); + break; + + case PROP_STATUS: + g_value_set_string (value, gtk_label_get_text(GTK_LABEL(priv->status_label))); + break; + + case PROP_TITLE: + g_value_set_string (value, gtk_label_get_text(GTK_LABEL(priv->title_label))); + break; + } +} + +static void anaconda_spoke_selector_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { + AnacondaSpokeSelector *widget = ANACONDA_SPOKE_SELECTOR(object); + AnacondaSpokeSelectorPrivate *priv = widget->priv; + + switch(prop_id) { + case PROP_ICON: + gtk_image_set_from_icon_name(GTK_IMAGE(priv->icon), g_value_get_string(value), GTK_ICON_SIZE_DIALOG); + break; + + case PROP_STATUS: { + char *markup = g_markup_printf_escaped("<span style='italic'>%s</span>", g_value_get_string(value)); + gtk_label_set_markup(GTK_LABEL(priv->status_label), markup); + g_free(markup); + break; + } + + case PROP_TITLE: { + char *markup = g_markup_printf_escaped("<span weight='bold'>%s</span>", g_value_get_string(value)); + gtk_label_set_markup(GTK_LABEL(priv->title_label), markup); + g_free(markup); + break; + } + } +} + +/** + * anaconda_spoke_selector_get_incomplete: + * @spoke: a #AnacondaSpokeSelector + * + * Returns whether or not this spoke has been completed. + * + * Returns: Whether @spoke has been completed by the user. + * + * Since: 1.0 + */ +gboolean anaconda_spoke_selector_get_incomplete(AnacondaSpokeSelector *spoke) { + return spoke->priv->is_incomplete; +} + +/** + * anaconda_spoke_selector_set_incomplete: + * @spoke: a #AnacondaSpokeSelector + * @is_incomplete: %TRUE if this spoke still needs to be visited. + * + * Specifies whether this spoke must still be visited by the user. If so, this + * means anaconda doesn't have enough information to continue and the user must + * take some action. A warning icon will be displayed alongside the spoke's + * icon, and the continue button will be disabled. + * + * Since: 1.0 + */ +void anaconda_spoke_selector_set_incomplete(AnacondaSpokeSelector *spoke, gboolean is_incomplete) { + spoke->priv->is_incomplete = is_incomplete; +} |