/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* glade-palette.c
*
* Copyright (C) 2006 The GNOME Foundation.
* Copyright (C) 2001-2005 Ximian, Inc.
*
* Authors:
* Chema Celorio
* Joaquin Cuenca Abela <e98cuenc@yahoo.com>
* Vincent Geddes <vgeddes@metroweb.co.za>
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
/**
* SECTION:glade-palette
* @Short_Description: A widget to select a #GladeWidgetClass for addition.
*
* #GladePalette is responsible for displaying the list of available
* #GladeWidgetClass types and publishing the currently selected class
* to the Glade core.
*/
#include "glade.h"
#include "glade-app.h"
#include "glade-palette.h"
#include "glade-palette-item.h"
#include "glade-palette-box.h"
#include "glade-palette-expander.h"
#include "glade-catalog.h"
#include "glade-project.h"
#include "glade-widget.h"
#include "glade-widget-adaptor.h"
#include <glib/gi18n-lib.h>
#include <gdk/gdk.h>
#define GLADE_PALETTE_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object),\
GLADE_TYPE_PALETTE, \
GladePalettePrivate))
struct _GladePalettePrivate
{
const GList *catalogs; /* List of widget catalogs */
GtkWidget *selector_hbox;
GtkWidget *selector_button;
GtkWidget *tray; /* Where all the item groups are contained */
GladePaletteItem *current_item; /* The currently selected item */
GSList *sections; /* List of GladePaletteExpanders */
GtkTooltips *tooltips; /* Tooltips for the item buttons */
GtkTooltips *static_tooltips; /* These tooltips never get disabled */
GtkSizeGroup *size_group; /* All items have the same dimensions */
GladeItemAppearance item_appearance;
gboolean use_small_item_icons;
gboolean sticky_selection_mode; /* whether sticky_selection mode has been enabled */
};
enum
{
TOGGLED,
LAST_SIGNAL
};
enum
{
PROP_0,
PROP_CURRENT_ITEM,
PROP_ITEM_APPEARANCE,
PROP_USE_SMALL_ITEM_ICONS,
PROP_SHOW_SELECTOR_BUTTON,
PROP_CATALOGS
};
static guint glade_palette_signals[LAST_SIGNAL] = {0};
static void glade_palette_append_item_group (GladePalette *palette, GladeWidgetGroup *group);
static void glade_palette_update_appearance (GladePalette *palette);
G_DEFINE_TYPE (GladePalette, glade_palette, GTK_TYPE_VBOX)
static void
selector_button_toggled_cb (GtkToggleButton *button, GladePalette *palette)
{
if (gtk_toggle_button_get_active (button))
{
glade_palette_deselect_current_item (palette, FALSE);
}
else if (glade_palette_get_current_item (palette) == FALSE)
{
gtk_toggle_button_set_active (button, TRUE);
}
}
static void
glade_palette_set_catalogs (GladePalette *palette, GList *catalogs)
{
GladePalettePrivate *priv;
GList *l;
g_return_if_fail (GLADE_IS_PALETTE (palette));
priv = GLADE_PALETTE_GET_PRIVATE (palette);
priv->catalogs = catalogs;
for (l = (GList *) priv->catalogs; l; l = l->next)
{
GList *groups = glade_catalog_get_widget_groups (GLADE_CATALOG (l->data));
for (; groups; groups = groups->next)
{
GladeWidgetGroup *group = GLADE_WIDGET_GROUP (groups->data);
if (glade_widget_group_get_adaptors (group))
glade_palette_append_item_group (palette, group);
}
}
gtk_widget_show_all (priv->tray);
g_object_unref (priv->size_group);
}
/**
* glade_palette_set_item_appearance:
* @palette: a #GladePalette
* @item_appearance: the item appearance
*
* Sets the appearance of the palette items.
*/
void
glade_palette_set_item_appearance (GladePalette *palette, GladeItemAppearance item_appearance)
{
GladePalettePrivate *priv;
g_return_if_fail (GLADE_IS_PALETTE (palette));
priv = GLADE_PALETTE_GET_PRIVATE (palette);
if (priv->item_appearance != item_appearance)
{
priv->item_appearance = item_appearance;
glade_palette_update_appearance (palette);
g_object_notify (G_OBJECT (palette), "item-appearance");
}
}
/**
* glade_palette_set_use_small_item_icons:
* @palette: a #GladePalette
* @use_small_item_icons: Whether to use small item icons
*
* Sets whether to use small item icons.
*/
void
glade_palette_set_use_small_item_icons (GladePalette *palette, gboolean use_small_item_icons)
{
GladePalettePrivate *priv;
g_return_if_fail (GLADE_IS_PALETTE (palette));
priv = GLADE_PALETTE_GET_PRIVATE (palette);
if (priv->use_small_item_icons != use_small_item_icons)
{
priv->use_small_item_icons = use_small_item_icons;
glade_palette_update_appearance (palette);
g_object_notify (G_OBJECT (palette), "use-small-item-icons");
}
}
/**
* glade_palette_set_show_selector_button:
* @palette: a #GladePalette
* @show_selector_button: whether to show selector button
*
* Sets whether to show the internal widget selector button
*/
void
glade_palette_set_show_selector_button (GladePalette *palette, gboolean show_selector_button)
{
GladePalettePrivate *priv;
g_return_if_fail (GLADE_IS_PALETTE (palette));
priv = GLADE_PALETTE_GET_PRIVATE (palette);
if (GTK_WIDGET_VISIBLE (priv->selector_hbox) != show_selector_button)
{
if (show_selector_button)
gtk_widget_show (priv->selector_hbox);
else
gtk_widget_hide (priv->selector_hbox);
g_object_notify (G_OBJECT (palette), "show-selector-button");
}
}
/* override GtkWidget::show_all since we have internal widgets we wish to keep
* hidden unless we decide otherwise, like the hidden selector button.
*/
static void
glade_palette_show_all (GtkWidget *widget)
{
gtk_widget_show (widget);
}
static void
glade_palette_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GladePalette *palette = GLADE_PALETTE (object);
switch (prop_id)
{
case PROP_USE_SMALL_ITEM_ICONS:
glade_palette_set_use_small_item_icons (palette, g_value_get_boolean (value));
break;
case PROP_ITEM_APPEARANCE:
glade_palette_set_item_appearance (palette, g_value_get_enum (value));
break;
case PROP_SHOW_SELECTOR_BUTTON:
glade_palette_set_show_selector_button (palette, g_value_get_boolean (value));
break;
case PROP_CATALOGS:
glade_palette_set_catalogs (palette, g_value_get_pointer (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
glade_palette_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GladePalette *palette = GLADE_PALETTE (object);
GladePalettePrivate *priv = GLADE_PALETTE_GET_PRIVATE (palette);
switch (prop_id)
{
case PROP_CURRENT_ITEM:
g_value_set_pointer (value, (gpointer) glade_palette_item_get_adaptor (priv->current_item));
break;
case PROP_USE_SMALL_ITEM_ICONS:
g_value_set_boolean (value, priv->use_small_item_icons);
break;
case PROP_SHOW_SELECTOR_BUTTON:
g_value_set_boolean (value, GTK_WIDGET_VISIBLE (priv->selector_button));
break;
case PROP_ITEM_APPEARANCE:
g_value_set_enum (value, priv->item_appearance);
break;
case PROP_CATALOGS:
g_value_set_pointer (value, (gpointer) priv->catalogs);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
glade_palette_dispose (GObject *object)
{
GladePalettePrivate *priv;
priv = GLADE_PALETTE_GET_PRIVATE (object);
priv->catalogs = NULL;
if (priv->tray)
{
g_object_unref (priv->tray);
priv->tray = NULL;
}
if (priv->tooltips)
{
g_object_unref (priv->tooltips);
priv->tooltips = NULL;
}
if (priv->static_tooltips)
{
g_object_unref (priv->static_tooltips);
priv->static_tooltips = NULL;
}
G_OBJECT_CLASS (glade_palette_parent_class)->dispose (object);
}
static void
glade_palette_finalize (GObject *object)
{
GladePalettePrivate *priv;
priv = GLADE_PALETTE_GET_PRIVATE (object);
g_slist_free (priv->sections);
G_OBJECT_CLASS (glade_palette_parent_class)->finalize (object);
}
static void
glade_palette_class_init (GladePaletteClass *klass)
{
GObjectClass *object_class;
GtkWidgetClass *widget_class;
object_class = G_OBJECT_CLASS (klass);
widget_class = GTK_WIDGET_CLASS (klass);
klass->toggled = NULL;
object_class->get_property = glade_palette_get_property;
object_class->set_property = glade_palette_set_property;
object_class->dispose = glade_palette_dispose;
object_class->finalize = glade_palette_finalize;
widget_class->show_all = glade_palette_show_all;
glade_palette_signals[TOGGLED] =
g_signal_new ("toggled",
G_TYPE_FROM_CLASS (object_class),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GladePaletteClass, toggled),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE,
0);
g_object_class_install_property (object_class,
PROP_ITEM_APPEARANCE,
g_param_spec_enum ("item-appearance",
"Item Appearance",
"The appearance of the palette items",
GLADE_TYPE_ITEM_APPEARANCE,
GLADE_ITEM_ICON_ONLY,
G_PARAM_READWRITE));
g_object_class_install_property (object_class,
PROP_ITEM_APPEARANCE,
g_param_spec_boolean ("use-small-item-icons",
"Use Small Item Icons",
"Whether to use small icons to represent items",
FALSE,
G_PARAM_READWRITE));
g_object_class_install_property (object_class,
PROP_ITEM_APPEARANCE,
g_param_spec_boolean ("show-selector-button",
"Show Selector Button",
"Whether to show the internal selector button",
TRUE,
G_PARAM_READWRITE));
g_object_class_install_property (object_class,
PROP_CURRENT_ITEM,
g_param_spec_pointer ("current-item",
"Current Item Class",
"The GladeWidgetAdaptor of the currently selected item",
G_PARAM_READABLE));
g_object_class_install_property (object_class,
PROP_CATALOGS,
g_param_spec_pointer ("catalogs",
"Widget catalogs",
"The widget catalogs for the palette",
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE));
g_type_class_add_private (object_class, sizeof (GladePalettePrivate));
}
static void
glade_palette_on_button_toggled (GtkWidget *button, GladePalette *palette)
{
GladePalettePrivate *priv;
GdkModifierType mask;
GladeWidgetAdaptor *adaptor;
g_return_if_fail (GLADE_IS_PALETTE (palette));
g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
priv = GLADE_PALETTE_GET_PRIVATE (palette);
/* if we are toggling currently active item into non-active state */
if (priv->current_item == GLADE_PALETTE_ITEM (button))
{
priv->current_item = NULL;
g_object_notify (G_OBJECT (palette), "current-item");
glade_app_set_pointer_mode (GLADE_POINTER_SELECT);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->selector_button), TRUE);
priv->sticky_selection_mode = FALSE;
g_signal_emit (G_OBJECT (palette), glade_palette_signals[TOGGLED], 0);
return;
}
/* now we are interested only in buttons which toggle from inactive to active */
if (!gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)))
return;
if (priv->current_item && (GLADE_PALETTE_ITEM (button) != priv->current_item))
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->current_item), FALSE);
priv->current_item = GLADE_PALETTE_ITEM (button);
g_object_notify (G_OBJECT (palette), "current-item");
glade_app_set_pointer_mode (GLADE_POINTER_ADD_WIDGET);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->selector_button), FALSE);
/* check whether to enable sticky selection */
adaptor = glade_palette_item_get_adaptor (GLADE_PALETTE_ITEM (button));
gdk_window_get_pointer (button->window, NULL, NULL, &mask);
priv->sticky_selection_mode = (!GWA_IS_TOPLEVEL (adaptor)) && (mask & GDK_CONTROL_MASK);
g_signal_emit (G_OBJECT (palette), glade_palette_signals[TOGGLED], 0);
}
static GtkWidget*
glade_palette_new_item (GladePalette *palette, GladeWidgetAdaptor *adaptor)
{
GladePalettePrivate *priv;
GtkWidget *item;
g_return_val_if_fail (GLADE_IS_PALETTE (palette), NULL);
g_return_val_if_fail (GLADE_IS_WIDGET_ADAPTOR (adaptor), NULL);
priv = GLADE_PALETTE_GET_PRIVATE (palette);
item = glade_palette_item_new (adaptor);
glade_palette_item_set_appearance (GLADE_PALETTE_ITEM (item), priv->item_appearance);
gtk_tooltips_set_tip (priv->tooltips, item, adaptor->title, NULL);
g_signal_connect (G_OBJECT (item), "toggled",
G_CALLBACK (glade_palette_on_button_toggled), palette);
return item;
}
static GtkWidget*
glade_palette_new_item_group (GladePalette *palette, GladeWidgetGroup *group)
{
GladePalettePrivate *priv;
GtkWidget *expander;
GtkWidget *box;
GtkWidget *item;
GList *l;
gchar *title;
g_return_val_if_fail (GLADE_IS_PALETTE (palette), NULL);
g_return_val_if_fail (group != NULL, NULL);
priv = GLADE_PALETTE_GET_PRIVATE (palette);
box = glade_palette_box_new ();
/* Go through all the widget classes in this catalog. */
for (l = (GList *) glade_widget_group_get_adaptors (group); l; l = l->next)
{
GladeWidgetAdaptor *adaptor = GLADE_WIDGET_ADAPTOR (l->data);
/* Create new item */
item = glade_palette_new_item (palette, adaptor);
gtk_size_group_add_widget (priv->size_group, GTK_WIDGET (item));
gtk_container_add (GTK_CONTAINER (box), item);
}
title = g_strdup_printf ("%s", glade_widget_group_get_title (group));
/* Put items box in a expander */
expander = glade_palette_expander_new (title);
glade_palette_expander_set_spacing (GLADE_PALETTE_EXPANDER (expander), 2);
glade_palette_expander_set_use_markup (GLADE_PALETTE_EXPANDER (expander), TRUE);
gtk_container_set_border_width (GTK_CONTAINER (expander), 0);
/* set default expanded state */
glade_palette_expander_set_expanded (GLADE_PALETTE_EXPANDER (expander),
glade_widget_group_get_expanded (group));
gtk_container_add (GTK_CONTAINER (expander), box);
g_free (title);
return expander;
}
static void
glade_palette_append_item_group (GladePalette *palette,
GladeWidgetGroup *group)
{
GladePalettePrivate *priv;
GtkWidget *expander;
g_return_if_fail (GLADE_IS_PALETTE (palette));
g_return_if_fail (group != NULL);
priv = GLADE_PALETTE_GET_PRIVATE (palette);
expander = glade_palette_new_item_group (palette, group);
priv->sections = g_slist_append (priv->sections, expander);
gtk_box_pack_start (GTK_BOX (priv->tray), expander, FALSE, FALSE, 0);
}
static void
glade_palette_update_appearance (GladePalette *palette)
{
GladePalettePrivate *priv;
GtkWidget *viewport;
GSList *sections;
GList *items, *i;
priv = GLADE_PALETTE_GET_PRIVATE (palette);
for (sections = priv->sections; sections; sections = sections->next)
{
items = gtk_container_get_children (GTK_CONTAINER (gtk_bin_get_child (GTK_BIN (sections->data))));
for (i = items; i; i = i->next)
{
glade_palette_item_set_appearance (GLADE_PALETTE_ITEM (i->data), priv->item_appearance);
glade_palette_item_set_use_small_icon (GLADE_PALETTE_ITEM (i->data), priv->use_small_item_icons);
}
g_list_free (items);
}
/* FIXME: Removing and then adding the tray again to the Viewport
* is the only way I can get the Viewport to
* respect the new width of the tray.
* There should be a better solution.
*/
viewport = gtk_widget_get_parent (priv->tray);
if (viewport != NULL)
{
gtk_container_remove (GTK_CONTAINER (viewport), priv->tray);
gtk_container_add (GTK_CONTAINER (viewport), priv->tray);
}
if (priv->item_appearance == GLADE_ITEM_ICON_ONLY)
gtk_tooltips_enable (priv->tooltips);
else
gtk_tooltips_disable (priv->tooltips);
}
static GtkWidget*
glade_palette_create_selector_button (GladePalette *palette)
{
GtkWidget *selector;
GtkWidget *image;
gchar *path;
/* create selector button */
selector = gtk_toggle_button_new ();
gtk_container_set_border_width (GTK_CONTAINER (selector), 0);
path = g_build_filename (glade_app_get_pixmaps_dir (), "selector.png", NULL);
image = gtk_image_new_from_file (path);
gtk_widget_show (image);
gtk_container_add (GTK_CONTAINER (selector), image);
gtk_button_set_relief (GTK_BUTTON (selector), GTK_RELIEF_NONE);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (selector), TRUE);
g_signal_connect (G_OBJECT (selector), "toggled",
G_CALLBACK (selector_button_toggled_cb),
palette);
g_free (path);
return selector;
}
static void
glade_palette_init (GladePalette *palette)
{
GladePalettePrivate *priv;
GtkWidget *sw;
priv = palette->priv = GLADE_PALETTE_GET_PRIVATE (palette);
priv->catalogs = NULL;
priv->current_item = NULL;
priv->sections = NULL;
priv->item_appearance = GLADE_ITEM_ICON_ONLY;
priv->use_small_item_icons = FALSE;
priv->sticky_selection_mode = FALSE;
/* create selector button */
priv->selector_button = glade_palette_create_selector_button (palette);
priv->selector_hbox = gtk_hbox_new (FALSE, 0);
gtk_box_pack_start (GTK_BOX (priv->selector_hbox), priv->selector_button, FALSE, FALSE, 0);
gtk_box_pack_start (GTK_BOX (palette), priv->selector_hbox, FALSE, FALSE, 0);
gtk_widget_show (priv->selector_button);
gtk_widget_show (priv->selector_hbox);
/* create tooltips */
priv->tooltips = gtk_tooltips_new ();
g_object_ref_sink (GTK_OBJECT (priv->tooltips));
priv->static_tooltips = gtk_tooltips_new ();
g_object_ref_sink (GTK_OBJECT (priv->static_tooltips));
gtk_tooltips_set_tip (priv->static_tooltips, priv->selector_button, _("Widget selector"), NULL);
/* create size group */
priv->size_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
gtk_size_group_set_ignore_hidden (priv->size_group, FALSE);
/* add items tray (via a scrolled window) */
priv->tray = gtk_vbox_new (FALSE, 0);
g_object_ref_sink (G_OBJECT (priv->tray));
gtk_container_set_border_width (GTK_CONTAINER (priv->tray), 1);
sw = gtk_scrolled_window_new (NULL, NULL);
gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sw),
GTK_POLICY_NEVER,
GTK_POLICY_AUTOMATIC);
gtk_scrolled_window_add_with_viewport (GTK_SCROLLED_WINDOW (sw), priv->tray);
gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (sw),
GTK_SHADOW_NONE);
gtk_box_pack_start (GTK_BOX (palette), sw, TRUE, TRUE, 0);
gtk_widget_show (sw);
gtk_widget_show (priv->tray);
gtk_widget_set_no_show_all (GTK_WIDGET (palette), TRUE);
}
/**
* glade_palette_get_current_item:
* @palette: a #GladePalette
*
* Gets the #GladeWidgetAdaptor of the currently selected item.
*
* Returns: the #GladeWidgetAdaptor of currently selected item, or NULL
* if no item is selected.
*/
GladeWidgetAdaptor *
glade_palette_get_current_item (GladePalette *palette)
{
g_return_val_if_fail (GLADE_IS_PALETTE (palette), NULL);
if (palette->priv->current_item)
{
return glade_palette_item_get_adaptor (palette->priv->current_item);
}
else
{
return NULL;
}
}
/**
* glade_palette_new:
* @catalogs: the widget catalogs for the palette.
*
* Creates a new #GladePalette widget
*
* Returns: a new #GladePalette
*/
GtkWidget*
glade_palette_new (const GList *catalogs)
{
GladePalette *palette;
g_return_val_if_fail (catalogs != NULL, NULL);
palette = g_object_new (GLADE_TYPE_PALETTE,
"spacing", 2,
"item-appearance", GLADE_ITEM_ICON_ONLY,
"catalogs", catalogs,
NULL);
return GTK_WIDGET (palette);
}
/**
* glade_palette_deselect_current_item:
* @palette: a #GladePalette
* @sticky_aware: whether to consider sticky selection mode
*
* Deselects the currently selected item
*/
void
glade_palette_deselect_current_item (GladePalette *palette, gboolean sticky_aware)
{
g_return_if_fail (GLADE_IS_PALETTE (palette));
if (sticky_aware && palette->priv->sticky_selection_mode)
return;
if (palette->priv->current_item)
{
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (palette->priv->current_item), FALSE);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (palette->priv->selector_button), TRUE);
palette->priv->current_item = NULL;
g_object_notify (G_OBJECT (palette), "current-item");
glade_app_set_pointer_mode (GLADE_POINTER_SELECT);
g_signal_emit (G_OBJECT (palette), glade_palette_signals[TOGGLED], 0);
}
}
/**
* glade_palette_get_item_appearance:
* @palette: a #GladePalette
*
* Returns: The appearance of the palette items
*/
GladeItemAppearance
glade_palette_get_item_appearance (GladePalette *palette)
{;
g_return_val_if_fail (GLADE_IS_PALETTE (palette), GLADE_ITEM_ICON_ONLY);
return palette->priv->item_appearance;
}
/**
* glade_palette_get_use_small_item_icons:
* @palette: a #GladePalette
*
* Returns: Whether small item icons are used
*/
gboolean
glade_palette_get_use_small_item_icons (GladePalette *palette)
{
g_return_val_if_fail (GLADE_IS_PALETTE (palette), FALSE);
return palette->priv->use_small_item_icons;
}
/**
* glade_palette_get_show_selector_button:
* @palette: a #GladePalette
*
* Returns: Whether the selector button is visible
*/
gboolean
glade_palette_get_show_selector_button (GladePalette *palette)
{
g_return_val_if_fail (GLADE_IS_PALETTE (palette), FALSE);
return GTK_WIDGET_VISIBLE (palette->priv->selector_hbox);
}
syntax highlighted by Code2HTML, v. 0.9.1