gtkrecentchooserdialog.c 11.4 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15
 * gtkrecentchooserdialog.c: Recent files selector dialog
 * Copyright (C) 2006 Emmanuele Bassi
 * 
 * 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
Javier Jardón's avatar
Javier Jardón committed
16
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 18
 */

19
#include "config.h"
20 21 22 23 24 25

#include "gtkrecentchooserdialog.h"
#include "gtkrecentchooserwidget.h"
#include "gtkrecentchooserutils.h"
#include "gtkrecentmanager.h"
#include "gtktypebuiltins.h"
26 27
#include "gtksettings.h"
#include "gtkdialogprivate.h"
28 29 30

#include <stdarg.h>

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

/**
 * SECTION:gtkrecentchooserdialog
 * @Short_description: Displays recently used files in a dialog
 * @Title: GtkRecentChooserDialog
 * @See_also:#GtkRecentChooser, #GtkDialog
 *
 * #GtkRecentChooserDialog is a dialog box suitable for displaying the recently
 * used documents.  This widgets works by putting a #GtkRecentChooserWidget inside
 * a #GtkDialog.  It exposes the #GtkRecentChooserIface interface, so you can use
 * all the #GtkRecentChooser functions on the recent chooser dialog as well as
 * those for #GtkDialog.
 *
 * Note that #GtkRecentChooserDialog does not have any methods of its own.
 * Instead, you should use the functions that work on a #GtkRecentChooser.
 *
47 48
 * ## Typical usage ## {#gtkrecentchooser-typical-usage}
 *
49 50
 * In the simplest of cases, you can use the following code to use
 * a #GtkRecentChooserDialog to select a recently used file:
51
 *
52
 * |[<!-- language="C" -->
53
 * GtkWidget *dialog;
54
 * gint res;
55 56 57
 *
 * dialog = gtk_recent_chooser_dialog_new ("Recent Documents",
 *                                         parent_window,
58 59 60 61
 *                                         _("_Cancel"),
 *                                         GTK_RESPONSE_CANCEL,
 *                                         _("_Open"),
 *                                         GTK_RESPONSE_ACCEPT,
62 63
 *                                         NULL);
 *
64 65
 * res = gtk_dialog_run (GTK_DIALOG (dialog));
 * if (res == GTK_RESPONSE_ACCEPT)
66 67
 *   {
 *     GtkRecentInfo *info;
68
 *     GtkRecentChooser *chooser = GTK_RECENT_CHOOSER (dialog);
69
 *
70
 *     info = gtk_recent_chooser_get_current_item (chooser);
71 72 73 74 75
 *     open_file (gtk_recent_info_get_uri (info));
 *     gtk_recent_info_unref (info);
 *   }
 *
 * gtk_widget_destroy (dialog);
76
 * ]|
77 78 79 80 81
 *
 * Recently used files are supported since GTK+ 2.10.
 */


82 83 84 85 86 87 88 89 90 91 92 93 94
struct _GtkRecentChooserDialogPrivate
{
  GtkRecentManager *manager;
  
  GtkWidget *chooser;
};

#define GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE(obj)	(GTK_RECENT_CHOOSER_DIALOG (obj)->priv)

static void gtk_recent_chooser_dialog_class_init (GtkRecentChooserDialogClass *klass);
static void gtk_recent_chooser_dialog_init       (GtkRecentChooserDialog      *dialog);
static void gtk_recent_chooser_dialog_finalize   (GObject                     *object);

95
static void gtk_recent_chooser_dialog_constructed (GObject *object);
96 97 98 99 100 101 102 103 104 105 106 107 108

static void gtk_recent_chooser_dialog_set_property (GObject      *object,
						    guint         prop_id,
						    const GValue *value,
						    GParamSpec   *pspec);
static void gtk_recent_chooser_dialog_get_property (GObject      *object,
						    guint         prop_id,
						    GValue       *value,
						    GParamSpec   *pspec);

G_DEFINE_TYPE_WITH_CODE (GtkRecentChooserDialog,
			 gtk_recent_chooser_dialog,
			 GTK_TYPE_DIALOG,
109
                         G_ADD_PRIVATE (GtkRecentChooserDialog)
110
			 G_IMPLEMENT_INTERFACE (GTK_TYPE_RECENT_CHOOSER,
Matthias Clasen's avatar
Matthias Clasen committed
111
		       				_gtk_recent_chooser_delegate_iface_init))
112 113 114 115 116 117 118 119

static void
gtk_recent_chooser_dialog_class_init (GtkRecentChooserDialogClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  
  gobject_class->set_property = gtk_recent_chooser_dialog_set_property;
  gobject_class->get_property = gtk_recent_chooser_dialog_get_property;
120
  gobject_class->constructed = gtk_recent_chooser_dialog_constructed;
121 122 123 124 125 126 127 128
  gobject_class->finalize = gtk_recent_chooser_dialog_finalize;
  
  _gtk_recent_chooser_install_properties (gobject_class);
}

static void
gtk_recent_chooser_dialog_init (GtkRecentChooserDialog *dialog)
{
129
  GtkRecentChooserDialogPrivate *priv;
130
  GtkWidget *content_area, *action_area;
131
  GtkDialog *rc_dialog = GTK_DIALOG (dialog);
132 133

  priv = gtk_recent_chooser_dialog_get_instance_private (dialog);
134
  dialog->priv = priv;
135
  gtk_dialog_set_use_header_bar_from_setting (GTK_DIALOG (dialog));
136

137
  content_area = gtk_dialog_get_content_area (rc_dialog);
138
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
139
  action_area = gtk_dialog_get_action_area (rc_dialog);
140
G_GNUC_END_IGNORE_DEPRECATIONS
141

142
  gtk_container_set_border_width (GTK_CONTAINER (rc_dialog), 5);
143 144
  gtk_box_set_spacing (GTK_BOX (content_area), 2); /* 2 * 5 + 2 = 12 */
  gtk_container_set_border_width (GTK_CONTAINER (action_area), 5);
145 146 147 148 149 150 151 152 153
}

/* we intercept the GtkRecentChooser::item_activated signal and try to
 * make the dialog emit a valid response signal
 */
static void
gtk_recent_chooser_item_activated_cb (GtkRecentChooser *chooser,
				      gpointer          user_data)
{
154
  GtkDialog *rc_dialog;
155
  GtkRecentChooserDialog *dialog;
156
  GtkWidget *action_area;
157 158 159
  GList *children, *l;

  dialog = GTK_RECENT_CHOOSER_DIALOG (user_data);
160
  rc_dialog = GTK_DIALOG (dialog);
161 162 163

  if (gtk_window_activate_default (GTK_WINDOW (dialog)))
    return;
164

165
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
166
  action_area = gtk_dialog_get_action_area (rc_dialog);
167
G_GNUC_END_IGNORE_DEPRECATIONS
168
  children = gtk_container_get_children (GTK_CONTAINER (action_area));
169 170 171 172 173 174 175
  
  for (l = children; l; l = l->next)
    {
      GtkWidget *widget;
      gint response_id;
      
      widget = GTK_WIDGET (l->data);
176
      response_id = gtk_dialog_get_response_for_widget (rc_dialog, widget);
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
      
      if (response_id == GTK_RESPONSE_ACCEPT ||
          response_id == GTK_RESPONSE_OK     ||
          response_id == GTK_RESPONSE_YES    ||
          response_id == GTK_RESPONSE_APPLY)
        {
          g_list_free (children);
	  
          gtk_dialog_response (GTK_DIALOG (dialog), response_id);

          return;
        }
    }
  
  g_list_free (children);
}

194 195
static void
gtk_recent_chooser_dialog_constructed (GObject *object)
196 197
{
  GtkRecentChooserDialogPrivate *priv;
198 199
  GtkWidget *content_area;

200
  G_OBJECT_CLASS (gtk_recent_chooser_dialog_parent_class)->constructed (object);
201
  priv = GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE (object);
202

203 204 205 206 207 208 209
  if (priv->manager)
    priv->chooser = g_object_new (GTK_TYPE_RECENT_CHOOSER_WIDGET,
  				  "recent-manager", priv->manager,
  				  NULL);
  else
    priv->chooser = g_object_new (GTK_TYPE_RECENT_CHOOSER_WIDGET, NULL);
  
210
  g_signal_connect (priv->chooser, "item-activated",
211 212
  		    G_CALLBACK (gtk_recent_chooser_item_activated_cb),
  		    object);
213

214 215
  content_area = gtk_dialog_get_content_area (GTK_DIALOG (object));

216
  gtk_container_set_border_width (GTK_CONTAINER (priv->chooser), 5);
217
  gtk_box_pack_start (GTK_BOX (content_area),
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
                      priv->chooser, TRUE, TRUE, 0);
  gtk_widget_show (priv->chooser);
  
  _gtk_recent_chooser_set_delegate (GTK_RECENT_CHOOSER (object),
  				    GTK_RECENT_CHOOSER (priv->chooser));
}

static void
gtk_recent_chooser_dialog_set_property (GObject      *object,
					guint         prop_id,
					const GValue *value,
					GParamSpec   *pspec)
{
  GtkRecentChooserDialogPrivate *priv;
  
  priv = GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE (object);
  
  switch (prop_id)
    {
    case GTK_RECENT_CHOOSER_PROP_RECENT_MANAGER:
      priv->manager = g_value_get_object (value);
      break;
    default:
      g_object_set_property (G_OBJECT (priv->chooser), pspec->name, value);
      break;
    }
}

static void
gtk_recent_chooser_dialog_get_property (GObject      *object,
					guint         prop_id,
					GValue       *value,
					GParamSpec   *pspec)
{
  GtkRecentChooserDialogPrivate *priv;
  
  priv = GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE (object);
  
  g_object_get_property (G_OBJECT (priv->chooser), pspec->name, value);
}

static void
gtk_recent_chooser_dialog_finalize (GObject *object)
{
  GtkRecentChooserDialog *dialog = GTK_RECENT_CHOOSER_DIALOG (object);
 
  dialog->priv->manager = NULL;
  
  G_OBJECT_CLASS (gtk_recent_chooser_dialog_parent_class)->finalize (object);
}

static GtkWidget *
gtk_recent_chooser_dialog_new_valist (const gchar      *title,
				      GtkWindow        *parent,
				      GtkRecentManager *manager,
				      const gchar      *first_button_text,
				      va_list           varargs)
{
  GtkWidget *result;
  const char *button_text = first_button_text;
  gint response_id;
279

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
  result = g_object_new (GTK_TYPE_RECENT_CHOOSER_DIALOG,
                         "title", title,
                         "recent-manager", manager,
                         NULL);
  
  if (parent)
    gtk_window_set_transient_for (GTK_WINDOW (result), parent);
  
  while (button_text)
    {
      response_id = va_arg (varargs, gint);
      gtk_dialog_add_button (GTK_DIALOG (result), button_text, response_id);
      button_text = va_arg (varargs, const gchar *);
    }
  
  return result;
}

/**
 * gtk_recent_chooser_dialog_new:
300 301 302
 * @title: (allow-none): Title of the dialog, or %NULL
 * @parent: (allow-none): Transient parent of the dialog, or %NULL,
 * @first_button_text: (allow-none): stock ID or text to go in the first button, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
303
 * @...: response ID for the first button, then additional (button, id)
304 305 306 307 308
 *   pairs, ending with %NULL
 *
 * Creates a new #GtkRecentChooserDialog.  This function is analogous to
 * gtk_dialog_new_with_buttons().
 *
309
 * Returns: a new #GtkRecentChooserDialog
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
 *
 * Since: 2.10
 */
GtkWidget *
gtk_recent_chooser_dialog_new (const gchar *title,
			       GtkWindow   *parent,
			       const gchar *first_button_text,
			       ...)
{
  GtkWidget *result;
  va_list varargs;
  
  va_start (varargs, first_button_text);
  result = gtk_recent_chooser_dialog_new_valist (title,
  						 parent,
  						 NULL,
  						 first_button_text,
  						 varargs);
  va_end (varargs);
  
  return result;
}

/**
 * gtk_recent_chooser_dialog_new_for_manager:
335 336
 * @title: (allow-none): Title of the dialog, or %NULL
 * @parent: (allow-none): Transient parent of the dialog, or %NULL,
337
 * @manager: a #GtkRecentManager
338
 * @first_button_text: (allow-none): stock ID or text to go in the first button, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
339
 * @...: response ID for the first button, then additional (button, id)
340 341 342 343 344 345 346
 *   pairs, ending with %NULL
 *
 * Creates a new #GtkRecentChooserDialog with a specified recent manager.
 *
 * This is useful if you have implemented your own recent manager, or if you
 * have a customized instance of a #GtkRecentManager object.
 *
347
 * Returns: a new #GtkRecentChooserDialog
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
 *
 * Since: 2.10
 */
GtkWidget *
gtk_recent_chooser_dialog_new_for_manager (const gchar      *title,
			                   GtkWindow        *parent,
			                   GtkRecentManager *manager,
			                   const gchar      *first_button_text,
			                   ...)
{
  GtkWidget *result;
  va_list varargs;
  
  va_start (varargs, first_button_text);
  result = gtk_recent_chooser_dialog_new_valist (title,
  						 parent,
  						 manager,
  						 first_button_text,
  						 varargs);
  va_end (varargs);
  
  return result;
}