Pileus Git - ~andy/gtk/blob - gtk/gtkassistant.c

   1 /*
   2  * GTK - The GIMP Toolkit
   3  * Copyright (C) 1999  Red Hat, Inc.
   4  * Copyright (C) 2002  Anders Carlsson <andersca@gnu.org>
   5  * Copyright (C) 2003  Matthias Clasen <mclasen@redhat.com>
   6  * Copyright (C) 2005  Carlos Garnacho Parro <carlosg@gnome.org>
   7  *
   8  * All rights reserved.
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, USA.
  24  */
  25
  26 /**
  27  * SECTION:gtkassistant
  28  * @Short_description: A widget used to guide users through multi-step operations
  29  * @Title: GtkAssistant
  30  *
  31  * A #GtkAssistant is a widget used to represent a generally complex
  32  * operation splitted in several steps, guiding the user through its pages
  33  * and controlling the page flow to collect the necessary data.
  34  *
  35  * The design of GtkAssistant is that it controls what buttons to show and
  36  * to make sensitive, based on what it knows about the page sequence and
  37  * the <link linkend="GtkAssistantPageType">type</link> of each page, in
  38  * addition to state information like the page
  39  * <link linkend="gtk-assistant-set-page-complete">completion</link> and
  40  * <link linkend="gtk-assistant-commit">committed</link> status.
  41  *
  42  * If you have a case that doesn't quite fit in #GtkAssistants way of
  43  * handling buttons, you can use the #GTK_ASSISTANT_PAGE_CUSTOM page type
  44  * and handle buttons yourself.
  45  *
  46  * <refsect2 id="GtkAssistant-BUILDER-UI">
  47  * <title>GtkAssistant as GtkBuildable</title>
  48  * <para>
  49  * The GtkAssistant implementation of the GtkBuildable interface exposes the
  50  * @action_area as internal children with the name "action_area".
  51  *
  52  * To add pages to an assistant in GtkBuilder, simply add it as a
  53  * &lt;child&gt; to the GtkAssistant object, and set its child properties
  54  * as necessary.
  55  * </para>
  56  * </refsect2>
  57  */
  58
  59 #include "config.h"
  60
  61 #include <atk/atk.h>
  62
  63 #include "gtkassistant.h"
  64
  65 #include "gtkaccessibleprivate.h"
  66 #include "gtkbutton.h"
  67 #include "gtkbox.h"
  68 #include "gtkeventbox.h"
  69 #include "gtknotebook.h"
  70 #include "gtkimage.h"
  71 #include "gtklabel.h"
  72 #include "gtksizegroup.h"
  73 #include "gtksizerequest.h"
  74 #include "gtkstock.h"
  75 #include "gtktypebuiltins.h"
  76 #include "gtkintl.h"
  77 #include "gtkprivate.h"
  78 #include "gtkbuildable.h"
  79
  80
  81 #define HEADER_SPACING 12
  82 #define ACTION_AREA_SPACING 12
  83
  84 typedef struct _GtkAssistantPage GtkAssistantPage;
  85
  86 struct _GtkAssistantPage
  87 {
  88   GtkAssistantPageType type;
  89   guint      complete     : 1;
  90   guint      complete_set : 1;
  91
  92   gchar *title;
  93
  94   GtkWidget *page;
  95   GtkWidget *regular_title;
  96   GtkWidget *current_title;
  97   GdkPixbuf *header_image;
  98   GdkPixbuf *sidebar_image;
  99 };
 100
 101 struct _GtkAssistantPrivate
 102 {
 103   GtkWidget *cancel;
 104   GtkWidget *forward;
 105   GtkWidget *back;
 106   GtkWidget *apply;
 107   GtkWidget *close;
 108   GtkWidget *last;
 109
 110   GtkWidget *sidebar;
 111   GtkWidget *content;
 112   GtkWidget *action_area;
 113
 114   GList     *pages;
 115   GSList    *visited_pages;
 116   GtkAssistantPage *current_page;
 117
 118   GtkSizeGroup *button_size_group;
 119   GtkSizeGroup *title_size_group;
 120
 121   GtkAssistantPageFunc forward_function;
 122   gpointer forward_function_data;
 123   GDestroyNotify forward_data_destroy;
 124
 125   gint extra_buttons;
 126
 127   guint committed : 1;
 128 };
 129
 130 static void     gtk_assistant_class_init         (GtkAssistantClass *class);
 131 static void     gtk_assistant_init               (GtkAssistant      *assistant);
 132 static void     gtk_assistant_destroy            (GtkWidget         *widget);
 133 static void     gtk_assistant_map                (GtkWidget         *widget);
 134 static void     gtk_assistant_unmap              (GtkWidget         *widget);
 135 static gboolean gtk_assistant_delete_event       (GtkWidget         *widget,
 136                                                   GdkEventAny       *event);
 137 static void     gtk_assistant_add                (GtkContainer      *container,
 138                                                   GtkWidget         *page);
 139 static void     gtk_assistant_remove             (GtkContainer      *container,
 140                                                   GtkWidget         *page);
 141 static void     gtk_assistant_set_child_property (GtkContainer      *container,
 142                                                   GtkWidget         *child,
 143                                                   guint              property_id,
 144                                                   const GValue      *value,
 145                                                   GParamSpec        *pspec);
 146 static void     gtk_assistant_get_child_property (GtkContainer      *container,
 147                                                   GtkWidget         *child,
 148                                                   guint              property_id,
 149                                                   GValue            *value,
 150                                                   GParamSpec        *pspec);
 151
 152 static AtkObject *gtk_assistant_get_accessible   (GtkWidget         *widget);
 153 static GType      gtk_assistant_accessible_factory_get_type  (void);
 154
 155 static void       gtk_assistant_buildable_interface_init     (GtkBuildableIface *iface);
 156 static GObject   *gtk_assistant_buildable_get_internal_child (GtkBuildable  *buildable,
 157                                                               GtkBuilder    *builder,
 158                                                               const gchar   *childname);
 159 static gboolean   gtk_assistant_buildable_custom_tag_start   (GtkBuildable  *buildable,
 160                                                               GtkBuilder    *builder,
 161                                                               GObject       *child,
 162                                                               const gchar   *tagname,
 163                                                               GMarkupParser *parser,
 164                                                               gpointer      *data);
 165 static void       gtk_assistant_buildable_custom_finished    (GtkBuildable  *buildable,
 166                                                               GtkBuilder    *builder,
 167                                                               GObject       *child,
 168                                                               const gchar   *tagname,
 169                                                               gpointer       user_data);
 170
 171 static GList*     find_page                                  (GtkAssistant  *assistant,
 172                                                               GtkWidget     *page);
 173
 174 enum
 175 {
 176   CHILD_PROP_0,
 177   CHILD_PROP_PAGE_TYPE,
 178   CHILD_PROP_PAGE_TITLE,
 179   CHILD_PROP_PAGE_HEADER_IMAGE,
 180   CHILD_PROP_PAGE_SIDEBAR_IMAGE,
 181   CHILD_PROP_PAGE_COMPLETE
 182 };
 183
 184 enum
 185 {
 186   CANCEL,
 187   PREPARE,
 188   APPLY,
 189   CLOSE,
 190   LAST_SIGNAL
 191 };
 192
 193 static guint signals [LAST_SIGNAL] = { 0 };
 194
 195
 196 G_DEFINE_TYPE_WITH_CODE (GtkAssistant, gtk_assistant, GTK_TYPE_WINDOW,
 197                          G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
 198                                                 gtk_assistant_buildable_interface_init))
 199
 200
 201 static void
 202 gtk_assistant_class_init (GtkAssistantClass *class)
 203 {
 204   GObjectClass *gobject_class;
 205   GtkWidgetClass *widget_class;
 206   GtkContainerClass *container_class;
 207
 208   gobject_class   = (GObjectClass *) class;
 209   widget_class    = (GtkWidgetClass *) class;
 210   container_class = (GtkContainerClass *) class;
 211
 212   widget_class->destroy = gtk_assistant_destroy;
 213   widget_class->map = gtk_assistant_map;
 214   widget_class->unmap = gtk_assistant_unmap;
 215   widget_class->delete_event = gtk_assistant_delete_event;
 216   widget_class->get_accessible = gtk_assistant_get_accessible;
 217
 218   container_class->add = gtk_assistant_add;
 219   container_class->remove = gtk_assistant_remove;
 220   container_class->set_child_property = gtk_assistant_set_child_property;
 221   container_class->get_child_property = gtk_assistant_get_child_property;
 222
 223   /**
 224    * GtkAssistant::cancel:
 225    * @assistant: the #GtkAssistant
 226    *
 227    * The ::cancel signal is emitted when then the cancel button is clicked.
 228    *
 229    * Since: 2.10
 230    */
 231   signals[CANCEL] =
 232     g_signal_new (I_("cancel"),
 233                   G_TYPE_FROM_CLASS (gobject_class),
 234                   G_SIGNAL_RUN_LAST,
 235                   G_STRUCT_OFFSET (GtkAssistantClass, cancel),
 236                   NULL, NULL,
 237                   g_cclosure_marshal_VOID__VOID,
 238                   G_TYPE_NONE, 0);
 239
 240   /**
 241    * GtkAssistant::prepare:
 242    * @assistant: the #GtkAssistant
 243    * @page: the current page
 244    *
 245    * The ::prepare signal is emitted when a new page is set as the
 246    * assistant's current page, before making the new page visible.
 247    *
 248    * A handler for this signal can do any preparations which are
 249    * necessary before showing @page.
 250    *
 251    * Since: 2.10
 252    */
 253   signals[PREPARE] =
 254     g_signal_new (I_("prepare"),
 255                   G_TYPE_FROM_CLASS (gobject_class),
 256                   G_SIGNAL_RUN_LAST,
 257                   G_STRUCT_OFFSET (GtkAssistantClass, prepare),
 258                   NULL, NULL,
 259                   g_cclosure_marshal_VOID__OBJECT,
 260                   G_TYPE_NONE, 1, GTK_TYPE_WIDGET);
 261
 262   /**
 263    * GtkAssistant::apply:
 264    * @assistant: the #GtkAssistant
 265    *
 266    * The ::apply signal is emitted when the apply button is clicked.
 267    *
 268    * The default behavior of the #GtkAssistant is to switch to the page
 269    * after the current page, unless the current page is the last one.
 270    *
 271    * A handler for the ::apply signal should carry out the actions for
 272    * which the wizard has collected data. If the action takes a long time
 273    * to complete, you might consider putting a page of type
 274    * %GTK_ASSISTANT_PAGE_PROGRESS after the confirmation page and handle
 275    * this operation within the #GtkAssistant::prepare signal of the progress
 276    * page.
 277    *
 278    * Since: 2.10
 279    */
 280   signals[APPLY] =
 281     g_signal_new (I_("apply"),
 282                   G_TYPE_FROM_CLASS (gobject_class),
 283                   G_SIGNAL_RUN_LAST,
 284                   G_STRUCT_OFFSET (GtkAssistantClass, apply),
 285                   NULL, NULL,
 286                   g_cclosure_marshal_VOID__VOID,
 287                   G_TYPE_NONE, 0);
 288
 289   /**
 290    * GtkAssistant::close:
 291    * @assistant: the #GtkAssistant
 292    *
 293    * The ::close signal is emitted either when the close button of
 294    * a summary page is clicked, or when the apply button in the last
 295    * page in the flow (of type %GTK_ASSISTANT_PAGE_CONFIRM) is clicked.
 296    *
 297    * Since: 2.10
 298    */
 299   signals[CLOSE] =
 300     g_signal_new (I_("close"),
 301                   G_TYPE_FROM_CLASS (gobject_class),
 302                   G_SIGNAL_RUN_LAST,
 303                   G_STRUCT_OFFSET (GtkAssistantClass, close),
 304                   NULL, NULL,
 305                   g_cclosure_marshal_VOID__VOID,
 306                   G_TYPE_NONE, 0);
 307
 308   gtk_widget_class_install_style_property (widget_class,
 309                                            g_param_spec_int ("header-padding",
 310                                                              P_("Header Padding"),
 311                                                              P_("Number of pixels around the header."),
 312                                                              0,
 313                                                              G_MAXINT,
 314                                                              6,
 315                                                              GTK_PARAM_READABLE));
 316   gtk_widget_class_install_style_property (widget_class,
 317                                            g_param_spec_int ("content-padding",
 318                                                              P_("Content Padding"),
 319                                                              P_("Number of pixels around the content pages."),
 320                                                              0,
 321                                                              G_MAXINT,
 322                                                              1,
 323                                                              GTK_PARAM_READABLE));
 324
 325   /**
 326    * GtkAssistant:page-type:
 327    *
 328    * The type of the assistant page.
 329    *
 330    * Since: 2.10
 331    */
 332   gtk_container_class_install_child_property (container_class,
 333                                               CHILD_PROP_PAGE_TYPE,
 334                                               g_param_spec_enum ("page-type",
 335                                                                  P_("Page type"),
 336                                                                  P_("The type of the assistant page"),
 337                                                                  GTK_TYPE_ASSISTANT_PAGE_TYPE,
 338                                                                  GTK_ASSISTANT_PAGE_CONTENT,
 339                                                                  GTK_PARAM_READWRITE));
 340
 341   /**
 342    * GtkAssistant:title:
 343    *
 344    * The title of the page.
 345    *
 346    * Since: 2.10
 347    */
 348   gtk_container_class_install_child_property (container_class,
 349                                               CHILD_PROP_PAGE_TITLE,
 350                                               g_param_spec_string ("title",
 351                                                                    P_("Page title"),
 352                                                                    P_("The title of the assistant page"),
 353                                                                    NULL,
 354                                                                    GTK_PARAM_READWRITE));
 355
 356   /**
 357    * GtkAssistant:header-image:
 358    *
 359    * This image used to be displayed in the page header.
 360    *
 361    * Since: 2.10
 362    *
 363    * Deprecated: 3.2: Since GTK+ 3.2, a header is no longer shown;
 364    *     add your header decoration to the page content instead.
 365    */
 366   gtk_container_class_install_child_property (container_class,
 367                                               CHILD_PROP_PAGE_HEADER_IMAGE,
 368                                               g_param_spec_object ("header-image",
 369                                                                    P_("Header image"),
 370                                                                    P_("Header image for the assistant page"),
 371                                                                    GDK_TYPE_PIXBUF,
 372                                                                    GTK_PARAM_READWRITE));
 373
 374   /**
 375    * GtkAssistant:sidebar-image:
 376    *
 377    * This image used to be displayed in the 'sidebar'.
 378    *
 379    * Since: 2.10
 380    *
 381    * Deprecated: 3.2: Since GTK+ 3.2, the sidebar image is no longer shown.
 382    */
 383   gtk_container_class_install_child_property (container_class,
 384                                               CHILD_PROP_PAGE_SIDEBAR_IMAGE,
 385                                               g_param_spec_object ("sidebar-image",
 386                                                                    P_("Sidebar image"),
 387                                                                    P_("Sidebar image for the assistant page"),
 388                                                                    GDK_TYPE_PIXBUF,
 389                                                                    GTK_PARAM_READWRITE));
 390
 391   /**
 392    * GtkAssistant:complete:
 393    *
 394    * Setting the "complete" child property to %TRUE marks a page as
 395    * complete (i.e.: all the required fields are filled out). GTK+ uses
 396    * this information to control the sensitivity of the navigation buttons.
 397    *
 398    * Since: 2.10
 399    */
 400   gtk_container_class_install_child_property (container_class,
 401                                               CHILD_PROP_PAGE_COMPLETE,
 402                                               g_param_spec_boolean ("complete",
 403                                                                     P_("Page complete"),
 404                                                                     P_("Whether all required fields on the page have been filled out"),
 405                                                                     FALSE,
 406                                                                     G_PARAM_READWRITE));
 407
 408   g_type_class_add_private (gobject_class, sizeof (GtkAssistantPrivate));
 409 }
 410
 411 static gint
 412 default_forward_function (gint current_page, gpointer data)
 413 {
 414   GtkAssistant *assistant;
 415   GtkAssistantPrivate *priv;
 416   GtkAssistantPage *page_info;
 417   GList *page_node;
 418
 419   assistant = GTK_ASSISTANT (data);
 420   priv = assistant->priv;
 421
 422   page_node = g_list_nth (priv->pages, ++current_page);
 423
 424   if (!page_node)
 425     return -1;
 426
 427   page_info = (GtkAssistantPage *) page_node->data;
 428
 429   while (page_node && !gtk_widget_get_visible (page_info->page))
 430     {
 431       page_node = page_node->next;
 432       current_page++;
 433
 434       if (page_node)
 435         page_info = (GtkAssistantPage *) page_node->data;
 436     }
 437
 438   return current_page;
 439 }
 440
 441 static gboolean
 442 last_button_visible (GtkAssistant *assistant, GtkAssistantPage *page)
 443 {
 444   GtkAssistantPrivate *priv = assistant->priv;
 445   GtkAssistantPage *page_info;
 446   gint count, page_num, n_pages;
 447
 448   if (page == NULL)
 449     return FALSE;
 450
 451   if (page->type != GTK_ASSISTANT_PAGE_CONTENT)
 452     return FALSE;
 453
 454   count = 0;
 455   page_num = g_list_index (priv->pages, page);
 456   n_pages  = g_list_length (priv->pages);
 457   page_info = page;
 458
 459   while (page_num >= 0 && page_num < n_pages &&
 460          page_info->type == GTK_ASSISTANT_PAGE_CONTENT &&
 461          (count == 0 || page_info->complete) &&
 462          count < n_pages)
 463     {
 464       page_num = (priv->forward_function) (page_num, priv->forward_function_data);
 465       page_info = g_list_nth_data (priv->pages, page_num);
 466
 467       count++;
 468     }
 469
 470   /* Make the last button visible if we can skip multiple
 471    * pages and end on a confirmation or summary page
 472    */
 473   if (count > 1 && page_info &&
 474       (page_info->type == GTK_ASSISTANT_PAGE_CONFIRM ||
 475        page_info->type == GTK_ASSISTANT_PAGE_SUMMARY))
 476     return TRUE;
 477   else
 478     return FALSE;
 479 }
 480
 481 static void
 482 update_actions_size (GtkAssistant *assistant)
 483 {
 484   GtkAssistantPrivate *priv = assistant->priv;
 485   GList *l;
 486   GtkAssistantPage *page;
 487   gint buttons, page_buttons;
 488
 489   if (!priv->current_page)
 490     return;
 491
 492   /* Some heuristics to find out how many buttons we should
 493    * reserve space for. It is possible to trick this code
 494    * with page forward functions and invisible pages, etc.
 495    */
 496   buttons = 0;
 497   for (l = priv->pages; l; l = l->next)
 498     {
 499       page = l->data;
 500
 501       if (!gtk_widget_get_visible (page->page))
 502         continue;
 503
 504       page_buttons = 2; /* cancel, forward/apply/close */
 505       if (l != priv->pages)
 506         page_buttons += 1; /* back */
 507       if (last_button_visible (assistant, page))
 508         page_buttons += 1; /* last */
 509
 510       buttons = MAX (buttons, page_buttons);
 511     }
 512
 513   buttons += priv->extra_buttons;
 514
 515   gtk_widget_set_size_request (priv->action_area,
 516                                buttons * gtk_widget_get_allocated_width (priv->cancel) + (buttons - 1) * 6,
 517                                -1);
 518 }
 519
 520 static void
 521 compute_last_button_state (GtkAssistant *assistant)
 522 {
 523   GtkAssistantPrivate *priv = assistant->priv;
 524
 525   gtk_widget_set_sensitive (priv->last, priv->current_page->complete);
 526   if (last_button_visible (assistant, priv->current_page))
 527     gtk_widget_show (priv->last);
 528   else
 529     gtk_widget_hide (priv->last);
 530 }
 531
 532 static void
 533 compute_progress_state (GtkAssistant *assistant)
 534 {
 535   GtkAssistantPrivate *priv = assistant->priv;
 536   gint page_num, n_pages;
 537
 538   n_pages = gtk_assistant_get_n_pages (assistant);
 539   page_num = gtk_assistant_get_current_page (assistant);
 540
 541   page_num = (priv->forward_function) (page_num, priv->forward_function_data);
 542
 543   if (page_num >= 0 && page_num < n_pages)
 544     gtk_widget_show (priv->forward);
 545   else
 546     gtk_widget_hide (priv->forward);
 547 }
 548
 549 static void
 550 update_buttons_state (GtkAssistant *assistant)
 551 {
 552   GtkAssistantPrivate *priv = assistant->priv;
 553
 554   if (!priv->current_page)
 555     return;
 556
 557   switch (priv->current_page->type)
 558     {
 559     case GTK_ASSISTANT_PAGE_INTRO:
 560       gtk_widget_set_sensitive (priv->cancel, TRUE);
 561       gtk_widget_set_sensitive (priv->forward, priv->current_page->complete);
 562       gtk_widget_grab_default (priv->forward);
 563       gtk_widget_show (priv->forward);
 564       gtk_widget_hide (priv->back);
 565       gtk_widget_hide (priv->apply);
 566       gtk_widget_hide (priv->close);
 567       compute_last_button_state (assistant);
 568       break;
 569     case GTK_ASSISTANT_PAGE_CONFIRM:
 570       gtk_widget_set_sensitive (priv->cancel, TRUE);
 571       gtk_widget_set_sensitive (priv->back, TRUE);
 572       gtk_widget_set_sensitive (priv->apply, priv->current_page->complete);
 573       gtk_widget_grab_default (priv->apply);
 574       gtk_widget_show (priv->back);
 575       gtk_widget_show (priv->apply);
 576       gtk_widget_hide (priv->forward);
 577       gtk_widget_hide (priv->close);
 578       gtk_widget_hide (priv->last);
 579       break;
 580     case GTK_ASSISTANT_PAGE_CONTENT:
 581       gtk_widget_set_sensitive (priv->cancel, TRUE);
 582       gtk_widget_set_sensitive (priv->back, TRUE);
 583       gtk_widget_set_sensitive (priv->forward, priv->current_page->complete);
 584       gtk_widget_grab_default (priv->forward);
 585       gtk_widget_show (priv->back);
 586       gtk_widget_show (priv->forward);
 587       gtk_widget_hide (priv->apply);
 588       gtk_widget_hide (priv->close);
 589       compute_last_button_state (assistant);
 590       break;
 591     case GTK_ASSISTANT_PAGE_SUMMARY:
 592       gtk_widget_set_sensitive (priv->close, priv->current_page->complete);
 593       gtk_widget_grab_default (priv->close);
 594       gtk_widget_show (priv->close);
 595       gtk_widget_hide (priv->back);
 596       gtk_widget_hide (priv->forward);
 597       gtk_widget_hide (priv->apply);
 598       gtk_widget_hide (priv->last);
 599       break;
 600     case GTK_ASSISTANT_PAGE_PROGRESS:
 601       gtk_widget_set_sensitive (priv->cancel, priv->current_page->complete);
 602       gtk_widget_set_sensitive (priv->back, priv->current_page->complete);
 603       gtk_widget_set_sensitive (priv->forward, priv->current_page->complete);
 604       gtk_widget_grab_default (priv->forward);
 605       gtk_widget_show (priv->back);
 606       gtk_widget_hide (priv->apply);
 607       gtk_widget_hide (priv->close);
 608       gtk_widget_hide (priv->last);
 609       compute_progress_state (assistant);
 610       break;
 611     case GTK_ASSISTANT_PAGE_CUSTOM:
 612       gtk_widget_hide (priv->cancel);
 613       gtk_widget_hide (priv->back);
 614       gtk_widget_hide (priv->forward);
 615       gtk_widget_hide (priv->apply);
 616       gtk_widget_hide (priv->last);
 617       gtk_widget_hide (priv->close);
 618       break;
 619     default:
 620       g_assert_not_reached ();
 621     }
 622
 623   if (priv->committed)
 624     gtk_widget_hide (priv->cancel);
 625   else if (priv->current_page->type == GTK_ASSISTANT_PAGE_SUMMARY ||
 626            priv->current_page->type == GTK_ASSISTANT_PAGE_CUSTOM)
 627     gtk_widget_hide (priv->cancel);
 628   else
 629     gtk_widget_show (priv->cancel);
 630
 631   /* this is quite general, we don't want to
 632    * go back if it's the first page
 633    */
 634   if (!priv->visited_pages)
 635     gtk_widget_hide (priv->back);
 636 }
 637
 638 static gboolean
 639 update_page_title_state (GtkAssistant *assistant, GList *list)
 640 {
 641   GtkAssistantPage *page, *other;
 642   GtkAssistantPrivate *priv = assistant->priv;
 643   gboolean visible;
 644   GList *l;
 645
 646   page = list->data;
 647
 648   if (page->title == NULL || page->title[0] == 0)
 649     visible = FALSE;
 650   else
 651     visible = gtk_widget_get_visible (page->page);
 652
 653   if (page == priv->current_page)
 654     {
 655       gtk_widget_set_visible (page->regular_title, FALSE);
 656       gtk_widget_set_visible (page->current_title, visible);
 657     }
 658   else
 659     {
 660       /* If multiple consecutive pages have the same title,
 661        * we only show it once, since it would otherwise look
 662        * silly. We have to be a little careful, since we
 663        * _always_ show the title of the current page.
 664        */
 665       if (list->prev)
 666         {
 667           other = list->prev->data;
 668           if (g_strcmp0 (page->title, other->title) == 0)
 669             visible = FALSE;
 670         }
 671       for (l = list->next; l; l = l->next)
 672         {
 673           other = l->data;
 674           if (g_strcmp0 (page->title, other->title) != 0)
 675             break;
 676
 677           if (other == priv->current_page)
 678             {
 679               visible = FALSE;
 680               break;
 681             }
 682         }
 683
 684       gtk_widget_set_visible (page->regular_title, visible);
 685       gtk_widget_set_visible (page->current_title, FALSE);
 686     }
 687
 688   return visible;
 689 }
 690
 691 static void
 692 update_title_state (GtkAssistant *assistant)
 693 {
 694   GtkAssistantPrivate *priv = assistant->priv;
 695   GList *l;
 696   gboolean show_titles;
 697
 698   show_titles = FALSE;
 699   for (l = priv->pages; l != NULL; l = l->next)
 700     {
 701       if (update_page_title_state (assistant, l))
 702         show_titles = TRUE;
 703     }
 704
 705   gtk_widget_set_visible (priv->sidebar, show_titles);
 706 }
 707
 708 static void
 709 set_current_page (GtkAssistant *assistant,
 710                   gint          page_num)
 711 {
 712   GtkAssistantPrivate *priv = assistant->priv;
 713
 714   priv->current_page = (GtkAssistantPage *)g_list_nth_data (priv->pages, page_num);
 715
 716   g_signal_emit (assistant, signals [PREPARE], 0, priv->current_page->page);
 717
 718   update_title_state (assistant);
 719
 720   gtk_notebook_set_current_page (GTK_NOTEBOOK (priv->content), page_num);
 721
 722   /* update buttons state, flow may have changed */
 723   if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
 724     update_buttons_state (assistant);
 725
 726   if (!gtk_widget_child_focus (priv->current_page->page, GTK_DIR_TAB_FORWARD))
 727     {
 728       GtkWidget *button[6];
 729       gint i;
 730
 731       /* find the best button to focus */
 732       button[0] = priv->apply;
 733       button[1] = priv->close;
 734       button[2] = priv->forward;
 735       button[3] = priv->back;
 736       button[4] = priv->cancel;
 737       button[5] = priv->last;
 738       for (i = 0; i < 6; i++)
 739         {
 740           if (gtk_widget_get_visible (button[i]) &&
 741               gtk_widget_get_sensitive (button[i]))
 742             {
 743               gtk_widget_grab_focus (button[i]);
 744               break;
 745             }
 746         }
 747     }
 748
 749   gtk_widget_queue_resize (GTK_WIDGET (assistant));
 750 }
 751
 752 static gint
 753 compute_next_step (GtkAssistant *assistant)
 754 {
 755   GtkAssistantPrivate *priv = assistant->priv;
 756   GtkAssistantPage *page_info;
 757   gint current_page, n_pages, next_page;
 758
 759   current_page = gtk_assistant_get_current_page (assistant);
 760   page_info = priv->current_page;
 761   n_pages = gtk_assistant_get_n_pages (assistant);
 762
 763   next_page = (priv->forward_function) (current_page,
 764                                         priv->forward_function_data);
 765
 766   if (next_page >= 0 && next_page < n_pages)
 767     {
 768       priv->visited_pages = g_slist_prepend (priv->visited_pages, page_info);
 769       set_current_page (assistant, next_page);
 770
 771       return TRUE;
 772     }
 773
 774   return FALSE;
 775 }
 776
 777 static void
 778 on_assistant_close (GtkWidget    *widget,
 779                     GtkAssistant *assistant)
 780 {
 781   g_signal_emit (assistant, signals [CLOSE], 0, NULL);
 782 }
 783
 784 static void
 785 on_assistant_apply (GtkWidget    *widget,
 786                     GtkAssistant *assistant)
 787 {
 788   gboolean success;
 789
 790   g_signal_emit (assistant, signals [APPLY], 0);
 791
 792   success = compute_next_step (assistant);
 793
 794   /* if the assistant hasn't switched to another page, just emit
 795    * the CLOSE signal, it't the last page in the assistant flow
 796    */
 797   if (!success)
 798     g_signal_emit (assistant, signals [CLOSE], 0);
 799 }
 800
 801 static void
 802 on_assistant_forward (GtkWidget    *widget,
 803                       GtkAssistant *assistant)
 804 {
 805   gtk_assistant_next_page (assistant);
 806 }
 807
 808 static void
 809 on_assistant_back (GtkWidget    *widget,
 810                    GtkAssistant *assistant)
 811 {
 812   gtk_assistant_previous_page (assistant);
 813 }
 814
 815 static void
 816 on_assistant_cancel (GtkWidget    *widget,
 817                      GtkAssistant *assistant)
 818 {
 819   g_signal_emit (assistant, signals [CANCEL], 0, NULL);
 820 }
 821
 822 static void
 823 on_assistant_last (GtkWidget    *widget,
 824                    GtkAssistant *assistant)
 825 {
 826   GtkAssistantPrivate *priv = assistant->priv;
 827
 828   while (priv->current_page->type == GTK_ASSISTANT_PAGE_CONTENT &&
 829          priv->current_page->complete)
 830     compute_next_step (assistant);
 831 }
 832
 833 static gboolean
 834 alternative_button_order (GtkAssistant *assistant)
 835 {
 836   GtkSettings *settings;
 837   GdkScreen *screen;
 838   gboolean result;
 839
 840   screen   = gtk_widget_get_screen (GTK_WIDGET (assistant));
 841   settings = gtk_settings_get_for_screen (screen);
 842
 843   g_object_get (settings,
 844                 "gtk-alternative-button-order", &result,
 845                 NULL);
 846   return result;
 847 }
 848
 849 static void
 850 gtk_assistant_init (GtkAssistant *assistant)
 851 {
 852   GtkAssistantPrivate *priv;
 853   GtkStyleContext *context;
 854   GtkWidget *main_box;
 855   GtkWidget *content_box;
 856   GtkWidget *side_box;
 857
 858   assistant->priv = G_TYPE_INSTANCE_GET_PRIVATE (assistant,
 859                                                  GTK_TYPE_ASSISTANT,
 860                                                  GtkAssistantPrivate);
 861   priv = assistant->priv;
 862
 863   /* use border on inner panes instead */
 864   gtk_container_set_border_width (GTK_CONTAINER (assistant), 0);
 865
 866   gtk_widget_push_composite_child ();
 867
 868   main_box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 12);
 869   priv->sidebar = gtk_box_new (GTK_ORIENTATION_VERTICAL, 6);
 870   gtk_container_set_border_width (GTK_CONTAINER (priv->sidebar), 12);
 871   /* Add an event box so we can set the background */
 872   side_box = gtk_event_box_new ();
 873   context = gtk_widget_get_style_context (side_box);
 874   gtk_style_context_add_class (context, GTK_STYLE_CLASS_SIDEBAR);
 875
 876   content_box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12);
 877   gtk_container_set_border_width (GTK_CONTAINER (content_box), 12);
 878   priv->content = gtk_notebook_new ();
 879   gtk_notebook_set_show_border (GTK_NOTEBOOK (priv->content), FALSE);
 880   gtk_notebook_set_show_tabs (GTK_NOTEBOOK (priv->content), FALSE);
 881   priv->action_area = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);
 882
 883   gtk_container_add (GTK_CONTAINER (side_box), priv->sidebar);
 884   gtk_box_pack_start (GTK_BOX (main_box), side_box, FALSE, FALSE, 0);
 885   gtk_box_pack_start (GTK_BOX (main_box), content_box, TRUE, TRUE, 0);
 886   gtk_box_pack_start (GTK_BOX (content_box), priv->content, TRUE, FALSE, 0);
 887   gtk_box_pack_start (GTK_BOX (content_box), priv->action_area, FALSE, TRUE, 0);
 888   gtk_widget_set_halign (priv->action_area, GTK_ALIGN_END);
 889
 890   gtk_widget_show_all (main_box);
 891
 892   gtk_widget_set_parent (main_box, GTK_WIDGET (assistant));
 893   _gtk_bin_set_child (GTK_BIN (assistant), main_box);
 894
 895   priv->close   = gtk_button_new_from_stock (GTK_STOCK_CLOSE);
 896   priv->apply   = gtk_button_new_from_stock (GTK_STOCK_APPLY);
 897   priv->forward = gtk_button_new_from_stock (GTK_STOCK_GO_FORWARD);
 898   priv->back    = gtk_button_new_from_stock (GTK_STOCK_GO_BACK);
 899   priv->cancel  = gtk_button_new_from_stock (GTK_STOCK_CANCEL);
 900   priv->last    = gtk_button_new_from_stock (GTK_STOCK_GOTO_LAST);
 901   gtk_widget_set_can_default (priv->close, TRUE);
 902   gtk_widget_set_can_default (priv->apply, TRUE);
 903   gtk_widget_set_can_default (priv->forward, TRUE);
 904
 905   priv->button_size_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
 906   gtk_size_group_add_widget (priv->button_size_group, priv->close);
 907   gtk_size_group_add_widget (priv->button_size_group, priv->apply);
 908   gtk_size_group_add_widget (priv->button_size_group, priv->forward);
 909   gtk_size_group_add_widget (priv->button_size_group, priv->back);
 910   gtk_size_group_add_widget (priv->button_size_group, priv->cancel);
 911   gtk_size_group_add_widget (priv->button_size_group, priv->last);
 912
 913   if (!alternative_button_order (assistant))
 914     {
 915       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->apply, FALSE, FALSE, 0);
 916       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->forward, FALSE, FALSE, 0);
 917       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->back, FALSE, FALSE, 0);
 918       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->last, FALSE, FALSE, 0);
 919       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->cancel, FALSE, FALSE, 0);
 920       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->close, FALSE, FALSE, 0);
 921     }
 922   else
 923     {
 924       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->close, FALSE, FALSE, 0);
 925       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->cancel, FALSE, FALSE, 0);
 926       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->apply, FALSE, FALSE, 0);
 927       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->forward, FALSE, FALSE, 0);
 928       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->back, FALSE, FALSE, 0);
 929       gtk_box_pack_end (GTK_BOX (priv->action_area), priv->last, FALSE, FALSE, 0);
 930     }
 931
 932   gtk_widget_show (priv->forward);
 933   gtk_widget_show (priv->back);
 934   gtk_widget_show (priv->cancel);
 935   gtk_widget_show (priv->action_area);
 936
 937   gtk_widget_pop_composite_child ();
 938
 939   priv->title_size_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
 940
 941   priv->pages = NULL;
 942   priv->current_page = NULL;
 943   priv->visited_pages = NULL;
 944
 945   priv->forward_function = default_forward_function;
 946   priv->forward_function_data = assistant;
 947   priv->forward_data_destroy = NULL;
 948
 949   g_signal_connect (G_OBJECT (priv->close), "clicked",
 950                     G_CALLBACK (on_assistant_close), assistant);
 951   g_signal_connect (G_OBJECT (priv->apply), "clicked",
 952                     G_CALLBACK (on_assistant_apply), assistant);
 953   g_signal_connect (G_OBJECT (priv->forward), "clicked",
 954                     G_CALLBACK (on_assistant_forward), assistant);
 955   g_signal_connect (G_OBJECT (priv->back), "clicked",
 956                     G_CALLBACK (on_assistant_back), assistant);
 957   g_signal_connect (G_OBJECT (priv->cancel), "clicked",
 958                     G_CALLBACK (on_assistant_cancel), assistant);
 959   g_signal_connect (G_OBJECT (priv->last), "clicked",
 960                     G_CALLBACK (on_assistant_last), assistant);
 961 }
 962
 963 static void
 964 gtk_assistant_set_child_property (GtkContainer *container,
 965                                   GtkWidget    *child,
 966                                   guint         property_id,
 967                                   const GValue *value,
 968                                   GParamSpec   *pspec)
 969 {
 970   switch (property_id)
 971     {
 972     case CHILD_PROP_PAGE_TYPE:
 973       gtk_assistant_set_page_type (GTK_ASSISTANT (container), child,
 974                                    g_value_get_enum (value));
 975       break;
 976     case CHILD_PROP_PAGE_TITLE:
 977       gtk_assistant_set_page_title (GTK_ASSISTANT (container), child,
 978                                     g_value_get_string (value));
 979       break;
 980     case CHILD_PROP_PAGE_HEADER_IMAGE:
 981       gtk_assistant_set_page_header_image (GTK_ASSISTANT (container), child,
 982                                            g_value_get_object (value));
 983       break;
 984     case CHILD_PROP_PAGE_SIDEBAR_IMAGE:
 985       gtk_assistant_set_page_side_image (GTK_ASSISTANT (container), child,
 986                                          g_value_get_object (value));
 987       break;
 988     case CHILD_PROP_PAGE_COMPLETE:
 989       gtk_assistant_set_page_complete (GTK_ASSISTANT (container), child,
 990                                        g_value_get_boolean (value));
 991       break;
 992     default:
 993       GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
 994       break;
 995     }
 996 }
 997
 998 static void
 999 gtk_assistant_get_child_property (GtkContainer *container,
1000                                   GtkWidget    *child,
1001                                   guint         property_id,
1002                                   GValue       *value,
1003                                   GParamSpec   *pspec)
1004 {
1005   switch (property_id)
1006     {
1007     case CHILD_PROP_PAGE_TYPE:
1008       g_value_set_enum (value,
1009                         gtk_assistant_get_page_type (GTK_ASSISTANT (container), child));
1010       break;
1011     case CHILD_PROP_PAGE_TITLE:
1012       g_value_set_string (value,
1013                           gtk_assistant_get_page_title (GTK_ASSISTANT (container), child));
1014       break;
1015     case CHILD_PROP_PAGE_HEADER_IMAGE:
1016       g_value_set_object (value,
1017                           gtk_assistant_get_page_header_image (GTK_ASSISTANT (container), child));
1018       break;
1019     case CHILD_PROP_PAGE_SIDEBAR_IMAGE:
1020       g_value_set_object (value,
1021                           gtk_assistant_get_page_side_image (GTK_ASSISTANT (container), child));
1022       break;
1023     case CHILD_PROP_PAGE_COMPLETE:
1024       g_value_set_boolean (value,
1025                            gtk_assistant_get_page_complete (GTK_ASSISTANT (container), child));
1026       break;
1027     default:
1028       GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
1029       break;
1030     }
1031 }
1032
1033 static void
1034 on_page_notify_visibility (GtkWidget  *widget,
1035                            GParamSpec *arg,
1036                            gpointer    data)
1037 {
1038   GtkAssistant *assistant = GTK_ASSISTANT (data);
1039
1040   if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
1041     {
1042       update_buttons_state (assistant);
1043       update_title_state (assistant);
1044     }
1045 }
1046
1047 static void
1048 remove_page (GtkAssistant *assistant,
1049              GList        *element)
1050 {
1051   GtkAssistantPrivate *priv = assistant->priv;
1052   GtkAssistantPage *page_info;
1053   GList *page_node;
1054
1055   page_info = element->data;
1056
1057   /* If this is the current page, we need to switch away. */
1058   if (page_info == priv->current_page)
1059     {
1060       if (!compute_next_step (assistant))
1061         {
1062           /* The best we can do at this point is probably to pick
1063            * the first visible page.
1064            */
1065           page_node = priv->pages;
1066
1067           while (page_node &&
1068                  !gtk_widget_get_visible (((GtkAssistantPage *) page_node->data)->page))
1069             page_node = page_node->next;
1070
1071           if (page_node == element)
1072             page_node = page_node->next;
1073
1074           if (page_node)
1075             priv->current_page = page_node->data;
1076           else
1077             priv->current_page = NULL;
1078         }
1079     }
1080
1081   g_signal_handlers_disconnect_by_func (page_info->page, on_page_notify_visibility, assistant);
1082
1083   gtk_size_group_remove_widget (priv->title_size_group, page_info->regular_title);
1084   gtk_size_group_remove_widget (priv->title_size_group, page_info->current_title);
1085
1086   gtk_container_remove (GTK_CONTAINER (priv->sidebar), page_info->regular_title);
1087   gtk_container_remove (GTK_CONTAINER (priv->sidebar), page_info->current_title);
1088
1089   gtk_notebook_remove_page (GTK_NOTEBOOK (priv->content), gtk_notebook_page_num (GTK_NOTEBOOK (priv->content), page_info->page));
1090   priv->pages = g_list_remove_link (priv->pages, element);
1091   priv->visited_pages = g_slist_remove_all (priv->visited_pages, page_info);
1092
1093   g_free (page_info->title);
1094
1095   g_slice_free (GtkAssistantPage, page_info);
1096   g_list_free_1 (element);
1097
1098   if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
1099     {
1100       update_buttons_state (assistant);
1101       update_actions_size (assistant);
1102     }
1103 }
1104
1105 static void
1106 gtk_assistant_destroy (GtkWidget *widget)
1107 {
1108   GtkAssistant *assistant = GTK_ASSISTANT (widget);
1109   GtkAssistantPrivate *priv = assistant->priv;
1110
1111   /* We set current to NULL so that the remove code doesn't try
1112    * to do anything funny
1113    */
1114   priv->current_page = NULL;
1115
1116   while (priv->pages)
1117     remove_page (assistant, priv->pages);
1118
1119   if (priv->sidebar)
1120     priv->sidebar = NULL;
1121
1122   if (priv->content)
1123     priv->content = NULL;
1124
1125   if (priv->action_area)
1126     priv->action_area = NULL;
1127
1128   if (priv->button_size_group)
1129     {
1130       g_object_unref (priv->button_size_group);
1131       priv->button_size_group = NULL;
1132     }
1133
1134   if (priv->title_size_group)
1135     {
1136       g_object_unref (priv->title_size_group);
1137       priv->title_size_group = NULL;
1138     }
1139
1140   if (priv->forward_function)
1141     {
1142       if (priv->forward_function_data &&
1143           priv->forward_data_destroy)
1144         priv->forward_data_destroy (priv->forward_function_data);
1145
1146       priv->forward_function = NULL;
1147       priv->forward_function_data = NULL;
1148       priv->forward_data_destroy = NULL;
1149     }
1150
1151   if (priv->visited_pages)
1152     {
1153       g_slist_free (priv->visited_pages);
1154       priv->visited_pages = NULL;
1155     }
1156
1157   GTK_WIDGET_CLASS (gtk_assistant_parent_class)->destroy (widget);
1158 }
1159
1160 static GList*
1161 find_page (GtkAssistant  *assistant,
1162            GtkWidget     *page)
1163 {
1164   GtkAssistantPrivate *priv = assistant->priv;
1165   GList *child = priv->pages;
1166
1167   while (child)
1168     {
1169       GtkAssistantPage *page_info = child->data;
1170       if (page_info->page == page)
1171         return child;
1172
1173       child = child->next;
1174     }
1175
1176   return NULL;
1177 }
1178
1179 static void
1180 gtk_assistant_map (GtkWidget *widget)
1181 {
1182   GtkAssistant *assistant = GTK_ASSISTANT (widget);
1183   GtkAssistantPrivate *priv = assistant->priv;
1184   GList *page_node;
1185   GtkAssistantPage *page;
1186   gint page_num;
1187
1188   /* if there's no default page, pick the first one */
1189   page = NULL;
1190   page_num = 0;
1191   if (!priv->current_page)
1192     {
1193       page_node = priv->pages;
1194
1195       while (page_node && !gtk_widget_get_visible (((GtkAssistantPage *) page_node->data)->page))
1196         {
1197           page_node = page_node->next;
1198           page_num++;
1199         }
1200
1201       if (page_node)
1202         page = page_node->data;
1203     }
1204
1205   if (page && gtk_widget_get_visible (page->page))
1206     set_current_page (assistant, page_num);
1207
1208   update_buttons_state (assistant);
1209   update_actions_size (assistant);
1210   update_title_state (assistant);
1211
1212   GTK_WIDGET_CLASS (gtk_assistant_parent_class)->map (widget);
1213 }
1214
1215 static void
1216 gtk_assistant_unmap (GtkWidget *widget)
1217 {
1218   GtkAssistant *assistant = GTK_ASSISTANT (widget);
1219   GtkAssistantPrivate *priv = assistant->priv;
1220
1221   g_slist_free (priv->visited_pages);
1222   priv->visited_pages = NULL;
1223   priv->current_page  = NULL;
1224
1225   GTK_WIDGET_CLASS (gtk_assistant_parent_class)->unmap (widget);
1226 }
1227
1228 static gboolean
1229 gtk_assistant_delete_event (GtkWidget   *widget,
1230                             GdkEventAny *event)
1231 {
1232   GtkAssistant *assistant = GTK_ASSISTANT (widget);
1233   GtkAssistantPrivate *priv = assistant->priv;
1234
1235   /* Do not allow cancelling in the middle of a progress page */
1236   if (priv->current_page &&
1237       (priv->current_page->type != GTK_ASSISTANT_PAGE_PROGRESS ||
1238        priv->current_page->complete))
1239     g_signal_emit (widget, signals [CANCEL], 0, NULL);
1240
1241   return TRUE;
1242 }
1243
1244 static void
1245 gtk_assistant_add (GtkContainer *container,
1246                    GtkWidget    *page)
1247 {
1248   gtk_assistant_append_page (GTK_ASSISTANT (container), page);
1249 }
1250
1251 static void
1252 gtk_assistant_remove (GtkContainer *container,
1253                       GtkWidget    *page)
1254 {
1255   GtkAssistant *assistant = (GtkAssistant*) container;
1256   GList *element;
1257
1258   element = find_page (assistant, page);
1259
1260   if (element)
1261     {
1262       remove_page (assistant, element);
1263       gtk_widget_queue_resize ((GtkWidget *) container);
1264     }
1265 }
1266
1267 /**
1268  * gtk_assistant_new:
1269  *
1270  * Creates a new #GtkAssistant.
1271  *
1272  * Return value: a newly created #GtkAssistant
1273  *
1274  * Since: 2.10
1275  */
1276 GtkWidget*
1277 gtk_assistant_new (void)
1278 {
1279   GtkWidget *assistant;
1280
1281   assistant = g_object_new (GTK_TYPE_ASSISTANT, NULL);
1282
1283   return assistant;
1284 }
1285
1286 /**
1287  * gtk_assistant_get_current_page:
1288  * @assistant: a #GtkAssistant
1289  *
1290  * Returns the page number of the current page.
1291  *
1292  * Return value: The index (starting from 0) of the current
1293  *     page in the @assistant, or -1 if the @assistant has no pages,
1294  *     or no current page.
1295  *
1296  * Since: 2.10
1297  */
1298 gint
1299 gtk_assistant_get_current_page (GtkAssistant *assistant)
1300 {
1301   GtkAssistantPrivate *priv;
1302
1303   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), -1);
1304
1305   priv = assistant->priv;
1306
1307   if (!priv->pages || !priv->current_page)
1308     return -1;
1309
1310   return g_list_index (priv->pages, priv->current_page);
1311 }
1312
1313 /**
1314  * gtk_assistant_set_current_page:
1315  * @assistant: a #GtkAssistant
1316  * @page_num: index of the page to switch to, starting from 0.
1317  *     If negative, the last page will be used. If greater
1318  *     than the number of pages in the @assistant, nothing
1319  *     will be done.
1320  *
1321  * Switches the page to @page_num.
1322  *
1323  * Note that this will only be necessary in custom buttons,
1324  * as the @assistant flow can be set with
1325  * gtk_assistant_set_forward_page_func().
1326  *
1327  * Since: 2.10
1328  */
1329 void
1330 gtk_assistant_set_current_page (GtkAssistant *assistant,
1331                                 gint          page_num)
1332 {
1333   GtkAssistantPrivate *priv;
1334   GtkAssistantPage *page;
1335
1336   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1337
1338   priv = assistant->priv;
1339
1340   if (page_num >= 0)
1341     page = (GtkAssistantPage *) g_list_nth_data (priv->pages, page_num);
1342   else
1343     {
1344       page = (GtkAssistantPage *) g_list_last (priv->pages)->data;
1345       page_num = g_list_length (priv->pages);
1346     }
1347
1348   g_return_if_fail (page != NULL);
1349
1350   if (priv->current_page == page)
1351     return;
1352
1353   /* only add the page to the visited list if the assistant is mapped,
1354    * if not, just use it as an initial page setting, for the cases where
1355    * the initial page is != to 0
1356    */
1357   if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
1358     priv->visited_pages = g_slist_prepend (priv->visited_pages,
1359                                            priv->current_page);
1360
1361   set_current_page (assistant, page_num);
1362 }
1363
1364 /**
1365  * gtk_assistant_next_page:
1366  * @assistant: a #GtkAssistant
1367  *
1368  * Navigate to the next page.
1369  *
1370  * It is a programming error to call this function when
1371  * there is no next page.
1372  *
1373  * This function is for use when creating pages of the
1374  * #GTK_ASSISTANT_PAGE_CUSTOM type.
1375  *
1376  * Since: 3.0
1377  */
1378 void
1379 gtk_assistant_next_page (GtkAssistant *assistant)
1380 {
1381   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1382
1383   if (!compute_next_step (assistant))
1384     g_critical ("Page flow is broken.\n"
1385                 "You may want to end it with a page of type\n"
1386                 "GTK_ASSISTANT_PAGE_CONFIRM or GTK_ASSISTANT_PAGE_SUMMARY");
1387 }
1388
1389 /**
1390  * gtk_assistant_previous_page:
1391  * @assistant: a #GtkAssistant
1392  *
1393  * Navigate to the previous visited page.
1394  *
1395  * It is a programming error to call this function when
1396  * no previous page is available.
1397  *
1398  * This function is for use when creating pages of the
1399  * #GTK_ASSISTANT_PAGE_CUSTOM type.
1400  *
1401  * Since: 3.0
1402  */
1403 void
1404 gtk_assistant_previous_page (GtkAssistant *assistant)
1405 {
1406   GtkAssistantPrivate *priv;
1407   GtkAssistantPage *page_info;
1408   GSList *page_node;
1409
1410   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1411
1412   priv = assistant->priv;
1413
1414   /* skip the progress pages when going back */
1415   do
1416     {
1417       page_node = priv->visited_pages;
1418
1419       g_return_if_fail (page_node != NULL);
1420
1421       priv->visited_pages = priv->visited_pages->next;
1422       page_info = (GtkAssistantPage *) page_node->data;
1423       g_slist_free_1 (page_node);
1424     }
1425   while (page_info->type == GTK_ASSISTANT_PAGE_PROGRESS ||
1426          !gtk_widget_get_visible (page_info->page));
1427
1428   set_current_page (assistant, g_list_index (priv->pages, page_info));
1429 }
1430
1431 /**
1432  * gtk_assistant_get_n_pages:
1433  * @assistant: a #GtkAssistant
1434  *
1435  * Returns the number of pages in the @assistant
1436  *
1437  * Return value: the number of pages in the @assistant
1438  *
1439  * Since: 2.10
1440  */
1441 gint
1442 gtk_assistant_get_n_pages (GtkAssistant *assistant)
1443 {
1444   GtkAssistantPrivate *priv;
1445
1446   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), 0);
1447
1448   priv = assistant->priv;
1449
1450   return g_list_length (priv->pages);
1451 }
1452
1453 /**
1454  * gtk_assistant_get_nth_page:
1455  * @assistant: a #GtkAssistant
1456  * @page_num: the index of a page in the @assistant,
1457  *     or -1 to get the last page
1458  *
1459  * Returns the child widget contained in page number @page_num.
1460  *
1461  * Return value: (transfer none): the child widget, or %NULL
1462  *     if @page_num is out of bounds
1463  *
1464  * Since: 2.10
1465  */
1466 GtkWidget*
1467 gtk_assistant_get_nth_page (GtkAssistant *assistant,
1468                             gint          page_num)
1469 {
1470   GtkAssistantPrivate *priv;
1471   GtkAssistantPage *page;
1472   GList *elem;
1473
1474   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), NULL);
1475   g_return_val_if_fail (page_num >= -1, NULL);
1476
1477   priv = assistant->priv;
1478
1479   if (page_num == -1)
1480     elem = g_list_last (priv->pages);
1481   else
1482     elem = g_list_nth (priv->pages, page_num);
1483
1484   if (!elem)
1485     return NULL;
1486
1487   page = (GtkAssistantPage *) elem->data;
1488
1489   return page->page;
1490 }
1491
1492 /**
1493  * gtk_assistant_prepend_page:
1494  * @assistant: a #GtkAssistant
1495  * @page: a #GtkWidget
1496  *
1497  * Prepends a page to the @assistant.
1498  *
1499  * Return value: the index (starting at 0) of the inserted page
1500  *
1501  * Since: 2.10
1502  */
1503 gint
1504 gtk_assistant_prepend_page (GtkAssistant *assistant,
1505                             GtkWidget    *page)
1506 {
1507   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), 0);
1508   g_return_val_if_fail (GTK_IS_WIDGET (page), 0);
1509
1510   return gtk_assistant_insert_page (assistant, page, 0);
1511 }
1512
1513 /**
1514  * gtk_assistant_append_page:
1515  * @assistant: a #GtkAssistant
1516  * @page: a #GtkWidget
1517  *
1518  * Appends a page to the @assistant.
1519  *
1520  * Return value: the index (starting at 0) of the inserted page
1521  *
1522  * Since: 2.10
1523  */
1524 gint
1525 gtk_assistant_append_page (GtkAssistant *assistant,
1526                            GtkWidget    *page)
1527 {
1528   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), 0);
1529   g_return_val_if_fail (GTK_IS_WIDGET (page), 0);
1530
1531   return gtk_assistant_insert_page (assistant, page, -1);
1532 }
1533
1534 /**
1535  * gtk_assistant_insert_page:
1536  * @assistant: a #GtkAssistant
1537  * @page: a #GtkWidget
1538  * @position: the index (starting at 0) at which to insert the page,
1539  *     or -1 to append the page to the @assistant
1540  *
1541  * Inserts a page in the @assistant at a given position.
1542  *
1543  * Return value: the index (starting from 0) of the inserted page
1544  *
1545  * Since: 2.10
1546  */
1547 gint
1548 gtk_assistant_insert_page (GtkAssistant *assistant,
1549                            GtkWidget    *page,
1550                            gint          position)
1551 {
1552   GtkAssistantPrivate *priv;
1553   GtkAssistantPage *page_info;
1554   gint n_pages;
1555   GtkStyleContext *context;
1556
1557   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), 0);
1558   g_return_val_if_fail (GTK_IS_WIDGET (page), 0);
1559   g_return_val_if_fail (gtk_widget_get_parent (page) == NULL, 0);
1560   g_return_val_if_fail (!gtk_widget_is_toplevel (page), 0);
1561
1562   priv = assistant->priv;
1563
1564   page_info = g_slice_new0 (GtkAssistantPage);
1565   page_info->page  = page;
1566   page_info->regular_title = gtk_label_new (NULL);
1567   page_info->current_title = gtk_label_new (NULL);
1568
1569   gtk_misc_set_alignment (GTK_MISC (page_info->regular_title), 0.,0.5);
1570   gtk_widget_show (page_info->regular_title);
1571
1572   gtk_misc_set_alignment (GTK_MISC (page_info->current_title), 0.,0.5);
1573   gtk_widget_hide (page_info->current_title);
1574
1575   context = gtk_widget_get_style_context (page_info->current_title);
1576   gtk_style_context_add_class (context, GTK_STYLE_CLASS_HIGHLIGHT);
1577   gtk_widget_reset_style (page_info->current_title);
1578
1579   gtk_size_group_add_widget (priv->title_size_group, page_info->regular_title);
1580   gtk_size_group_add_widget (priv->title_size_group, page_info->current_title);
1581
1582   g_signal_connect (G_OBJECT (page), "notify::visible",
1583                     G_CALLBACK (on_page_notify_visibility), assistant);
1584
1585   n_pages = g_list_length (priv->pages);
1586
1587   if (position < 0 || position > n_pages)
1588     position = n_pages;
1589
1590   priv->pages = g_list_insert (priv->pages, page_info, position);
1591
1592   gtk_box_pack_start (GTK_BOX (priv->sidebar), page_info->regular_title, FALSE, FALSE, 0);
1593   gtk_box_pack_start (GTK_BOX (priv->sidebar), page_info->current_title, FALSE, FALSE, 0);
1594   gtk_box_reorder_child (GTK_BOX (priv->sidebar), page_info->regular_title, 2 * position);
1595   gtk_box_reorder_child (GTK_BOX (priv->sidebar), page_info->current_title, 2 * position + 1);
1596
1597   gtk_notebook_insert_page (GTK_NOTEBOOK (priv->content), page, NULL, position);
1598
1599   if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
1600     {
1601       update_buttons_state (assistant);
1602       update_actions_size (assistant);
1603     }
1604
1605   return position;
1606 }
1607
1608 /**
1609  * gtk_assistant_set_forward_page_func:
1610  * @assistant: a #GtkAssistant
1611  * @page_func: (allow-none): the #GtkAssistantPageFunc, or %NULL
1612  *     to use the default one
1613  * @data: user data for @page_func
1614  * @destroy: destroy notifier for @data
1615  *
1616  * Sets the page forwarding function to be @page_func.
1617  *
1618  * This function will be used to determine what will be
1619  * the next page when the user presses the forward button.
1620  * Setting @page_func to %NULL will make the assistant to
1621  * use the default forward function, which just goes to the
1622  * next visible page.
1623  *
1624  * Since: 2.10
1625  */
1626 void
1627 gtk_assistant_set_forward_page_func (GtkAssistant         *assistant,
1628                                      GtkAssistantPageFunc  page_func,
1629                                      gpointer              data,
1630                                      GDestroyNotify        destroy)
1631 {
1632   GtkAssistantPrivate *priv;
1633
1634   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1635
1636   priv = assistant->priv;
1637
1638   if (priv->forward_data_destroy &&
1639       priv->forward_function_data)
1640     (*priv->forward_data_destroy) (priv->forward_function_data);
1641
1642   if (page_func)
1643     {
1644       priv->forward_function = page_func;
1645       priv->forward_function_data = data;
1646       priv->forward_data_destroy = destroy;
1647     }
1648   else
1649     {
1650       priv->forward_function = default_forward_function;
1651       priv->forward_function_data = assistant;
1652       priv->forward_data_destroy = NULL;
1653     }
1654
1655   /* Page flow has possibly changed, so the
1656    * buttons state might need to change too
1657    */
1658   if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
1659     update_buttons_state (assistant);
1660 }
1661
1662 /**
1663  * gtk_assistant_add_action_widget:
1664  * @assistant: a #GtkAssistant
1665  * @child: a #GtkWidget
1666  *
1667  * Adds a widget to the action area of a #GtkAssistant.
1668  *
1669  * Since: 2.10
1670  */
1671 void
1672 gtk_assistant_add_action_widget (GtkAssistant *assistant,
1673                                  GtkWidget    *child)
1674 {
1675   GtkAssistantPrivate *priv;
1676
1677   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1678   g_return_if_fail (GTK_IS_WIDGET (child));
1679
1680   priv = assistant->priv;
1681
1682   if (GTK_IS_BUTTON (child))
1683     {
1684       gtk_size_group_add_widget (priv->button_size_group, child);
1685       priv->extra_buttons += 1;
1686       if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
1687         update_actions_size (assistant);
1688     }
1689
1690   gtk_box_pack_end (GTK_BOX (priv->action_area), child, FALSE, FALSE, 0);
1691 }
1692
1693 /**
1694  * gtk_assistant_remove_action_widget:
1695  * @assistant: a #GtkAssistant
1696  * @child: a #GtkWidget
1697  *
1698  * Removes a widget from the action area of a #GtkAssistant.
1699  *
1700  * Since: 2.10
1701  */
1702 void
1703 gtk_assistant_remove_action_widget (GtkAssistant *assistant,
1704                                     GtkWidget    *child)
1705 {
1706   GtkAssistantPrivate *priv;
1707
1708   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1709   g_return_if_fail (GTK_IS_WIDGET (child));
1710
1711   priv = assistant->priv;
1712
1713   if (GTK_IS_BUTTON (child))
1714     {
1715       gtk_size_group_remove_widget (priv->button_size_group, child);
1716       priv->extra_buttons -= 1;
1717       if (gtk_widget_get_mapped (GTK_WIDGET (assistant)))
1718         update_actions_size (assistant);
1719     }
1720
1721   gtk_container_remove (GTK_CONTAINER (priv->action_area), child);
1722 }
1723
1724 /**
1725  * gtk_assistant_set_page_title:
1726  * @assistant: a #GtkAssistant
1727  * @page: a page of @assistant
1728  * @title: the new title for @page
1729  *
1730  * Sets a title for @page.
1731  *
1732  * The title is displayed in the header area of the assistant
1733  * when @page is the current page.
1734  *
1735  * Since: 2.10
1736  */
1737 void
1738 gtk_assistant_set_page_title (GtkAssistant *assistant,
1739                               GtkWidget    *page,
1740                               const gchar  *title)
1741 {
1742   GtkAssistantPage *page_info;
1743   GList *child;
1744
1745   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1746   g_return_if_fail (GTK_IS_WIDGET (page));
1747
1748   child = find_page (assistant, page);
1749
1750   g_return_if_fail (child != NULL);
1751
1752   page_info = (GtkAssistantPage*) child->data;
1753
1754   g_free (page_info->title);
1755   page_info->title = g_strdup (title);
1756
1757   gtk_label_set_text ((GtkLabel*) page_info->regular_title, title);
1758   gtk_label_set_text ((GtkLabel*) page_info->current_title, title);
1759
1760   gtk_widget_queue_resize (GTK_WIDGET (assistant));
1761   gtk_container_child_notify (GTK_CONTAINER (assistant), page, "title");
1762 }
1763
1764 /**
1765  * gtk_assistant_get_page_title:
1766  * @assistant: a #GtkAssistant
1767  * @page: a page of @assistant
1768  *
1769  * Gets the title for @page.
1770  *
1771  * Return value: the title for @page
1772  *
1773  * Since: 2.10
1774  */
1775 G_CONST_RETURN gchar*
1776 gtk_assistant_get_page_title (GtkAssistant *assistant,
1777                               GtkWidget    *page)
1778 {
1779   GtkAssistantPage *page_info;
1780   GList *child;
1781
1782   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), NULL);
1783   g_return_val_if_fail (GTK_IS_WIDGET (page), NULL);
1784
1785   child = find_page (assistant, page);
1786
1787   g_return_val_if_fail (child != NULL, NULL);
1788
1789   page_info = (GtkAssistantPage*) child->data;
1790
1791   return page_info->title;
1792 }
1793
1794 /**
1795  * gtk_assistant_set_page_type:
1796  * @assistant: a #GtkAssistant
1797  * @page: a page of @assistant
1798  * @type: the new type for @page
1799  *
1800  * Sets the page type for @page.
1801  *
1802  * The page type determines the page behavior in the @assistant.
1803  *
1804  * Since: 2.10
1805  */
1806 void
1807 gtk_assistant_set_page_type (GtkAssistant         *assistant,
1808                              GtkWidget            *page,
1809                              GtkAssistantPageType  type)
1810 {
1811   GtkAssistantPage *page_info;
1812   GList *child;
1813
1814   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1815   g_return_if_fail (GTK_IS_WIDGET (page));
1816
1817   child = find_page (assistant, page);
1818
1819   g_return_if_fail (child != NULL);
1820
1821   page_info = (GtkAssistantPage*) child->data;
1822
1823   if (type != page_info->type)
1824     {
1825       page_info->type = type;
1826
1827       /* backwards compatibility to the era before fixing bug 604289 */
1828       if (type == GTK_ASSISTANT_PAGE_SUMMARY && !page_info->complete_set)
1829         {
1830           gtk_assistant_set_page_complete (assistant, page, TRUE);
1831           page_info->complete_set = FALSE;
1832         }
1833
1834       /* Always set buttons state, a change in a future page
1835        * might change current page buttons
1836        */
1837       update_buttons_state (assistant);
1838
1839       gtk_container_child_notify (GTK_CONTAINER (assistant), page, "page-type");
1840     }
1841 }
1842
1843 /**
1844  * gtk_assistant_get_page_type:
1845  * @assistant: a #GtkAssistant
1846  * @page: a page of @assistant
1847  *
1848  * Gets the page type of @page.
1849  *
1850  * Return value: the page type of @page
1851  *
1852  * Since: 2.10
1853  */
1854 GtkAssistantPageType
1855 gtk_assistant_get_page_type (GtkAssistant *assistant,
1856                              GtkWidget    *page)
1857 {
1858   GtkAssistantPage *page_info;
1859   GList *child;
1860
1861   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), GTK_ASSISTANT_PAGE_CONTENT);
1862   g_return_val_if_fail (GTK_IS_WIDGET (page), GTK_ASSISTANT_PAGE_CONTENT);
1863
1864   child = find_page (assistant, page);
1865
1866   g_return_val_if_fail (child != NULL, GTK_ASSISTANT_PAGE_CONTENT);
1867
1868   page_info = (GtkAssistantPage*) child->data;
1869
1870   return page_info->type;
1871 }
1872
1873 /**
1874  * gtk_assistant_set_page_header_image:
1875  * @assistant: a #GtkAssistant
1876  * @page: a page of @assistant
1877  * @pixbuf: (allow-none): the new header image @page
1878  *
1879  * Sets a header image for @page.
1880  *
1881  * Since: 2.10
1882  *
1883  * Deprecated: 3.2: Since GTK+ 3.2, a header is no longer shown;
1884  *     add your header decoration to the page content instead.
1885  */
1886 void
1887 gtk_assistant_set_page_header_image (GtkAssistant *assistant,
1888                                      GtkWidget    *page,
1889                                      GdkPixbuf    *pixbuf)
1890 {
1891   GtkAssistantPage *page_info;
1892   GList *child;
1893
1894   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1895   g_return_if_fail (GTK_IS_WIDGET (page));
1896   g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
1897
1898   child = find_page (assistant, page);
1899
1900   g_return_if_fail (child != NULL);
1901
1902   page_info = (GtkAssistantPage*) child->data;
1903
1904   if (pixbuf != page_info->header_image)
1905     {
1906       if (page_info->header_image)
1907         {
1908           g_object_unref (page_info->header_image);
1909           page_info->header_image = NULL;
1910         }
1911
1912       if (pixbuf)
1913         page_info->header_image = g_object_ref (pixbuf);
1914
1915       gtk_container_child_notify (GTK_CONTAINER (assistant), page, "header-image");
1916     }
1917 }
1918
1919 /**
1920  * gtk_assistant_get_page_header_image:
1921  * @assistant: a #GtkAssistant
1922  * @page: a page of @assistant
1923  *
1924  * Gets the header image for @page.
1925  *
1926  * Return value: (transfer none): the header image for @page,
1927  *     or %NULL if there's no header image for the page
1928  *
1929  * Since: 2.10
1930  *
1931  * Deprecated: 3.2: Since GTK+ 3.2, a header is no longer shown;
1932  *     add your header decoration to the page content instead.
1933  */
1934 GdkPixbuf*
1935 gtk_assistant_get_page_header_image (GtkAssistant *assistant,
1936                                      GtkWidget    *page)
1937 {
1938   GtkAssistantPage *page_info;
1939   GList *child;
1940
1941   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), NULL);
1942   g_return_val_if_fail (GTK_IS_WIDGET (page), NULL);
1943
1944   child = find_page (assistant, page);
1945
1946   g_return_val_if_fail (child != NULL, NULL);
1947
1948   page_info = (GtkAssistantPage*) child->data;
1949
1950   return page_info->header_image;
1951 }
1952
1953 /**
1954  * gtk_assistant_set_page_side_image:
1955  * @assistant: a #GtkAssistant
1956  * @page: a page of @assistant
1957  * @pixbuf: (allow-none): the new side image @page
1958  *
1959  * Sets a side image for @page.
1960  *
1961  * This image used to be displayed in the side area of the assistant
1962  * when @page is the current page.
1963  *
1964  * Since: 2.10
1965  *
1966  * Deprecated: 3.2: Since GTK+ 3.2, sidebar images are not
1967  *     shown anymore.
1968  */
1969 void
1970 gtk_assistant_set_page_side_image (GtkAssistant *assistant,
1971                                    GtkWidget    *page,
1972                                    GdkPixbuf    *pixbuf)
1973 {
1974   GtkAssistantPage *page_info;
1975   GList *child;
1976
1977   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
1978   g_return_if_fail (GTK_IS_WIDGET (page));
1979   g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
1980
1981   child = find_page (assistant, page);
1982
1983   g_return_if_fail (child != NULL);
1984
1985   page_info = (GtkAssistantPage*) child->data;
1986
1987   if (pixbuf != page_info->sidebar_image)
1988     {
1989       if (page_info->sidebar_image)
1990         {
1991           g_object_unref (page_info->sidebar_image);
1992           page_info->sidebar_image = NULL;
1993         }
1994
1995       if (pixbuf)
1996         page_info->sidebar_image = g_object_ref (pixbuf);
1997
1998       gtk_container_child_notify (GTK_CONTAINER (assistant), page, "sidebar-image");
1999     }
2000 }
2001
2002 /**
2003  * gtk_assistant_get_page_side_image:
2004  * @assistant: a #GtkAssistant
2005  * @page: a page of @assistant
2006  *
2007  * Gets the side image for @page.
2008  *
2009  * Return value: (transfer none): the side image for @page,
2010  *     or %NULL if there's no side image for the page
2011  *
2012  * Since: 2.10
2013  *
2014  * Deprecated: 3.2: Since GTK+ 3.2, sidebar images are not
2015  *     shown anymore.
2016  */
2017 GdkPixbuf*
2018 gtk_assistant_get_page_side_image (GtkAssistant *assistant,
2019                                    GtkWidget    *page)
2020 {
2021   GtkAssistantPage *page_info;
2022   GList *child;
2023
2024   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), NULL);
2025   g_return_val_if_fail (GTK_IS_WIDGET (page), NULL);
2026
2027   child = find_page (assistant, page);
2028
2029   g_return_val_if_fail (child != NULL, NULL);
2030
2031   page_info = (GtkAssistantPage*) child->data;
2032
2033   return page_info->sidebar_image;
2034 }
2035
2036 /**
2037  * gtk_assistant_set_page_complete:
2038  * @assistant: a #GtkAssistant
2039  * @page: a page of @assistant
2040  * @complete: the completeness status of the page
2041  *
2042  * Sets whether @page contents are complete.
2043  *
2044  * This will make @assistant update the buttons state
2045  * to be able to continue the task.
2046  *
2047  * Since: 2.10
2048  */
2049 void
2050 gtk_assistant_set_page_complete (GtkAssistant *assistant,
2051                                  GtkWidget    *page,
2052                                  gboolean      complete)
2053 {
2054   GtkAssistantPage *page_info;
2055   GList *child;
2056
2057   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
2058   g_return_if_fail (GTK_IS_WIDGET (page));
2059
2060   child = find_page (assistant, page);
2061
2062   g_return_if_fail (child != NULL);
2063
2064   page_info = (GtkAssistantPage*) child->data;
2065
2066   if (complete != page_info->complete)
2067     {
2068       page_info->complete = complete;
2069       page_info->complete_set = TRUE;
2070
2071       /* Always set buttons state, a change in a future page
2072        * might change current page buttons
2073        */
2074       update_buttons_state (assistant);
2075
2076       gtk_container_child_notify (GTK_CONTAINER (assistant), page, "complete");
2077     }
2078 }
2079
2080 /**
2081  * gtk_assistant_get_page_complete:
2082  * @assistant: a #GtkAssistant
2083  * @page: a page of @assistant
2084  *
2085  * Gets whether @page is complete.
2086  *
2087  * Return value: %TRUE if @page is complete.
2088  *
2089  * Since: 2.10
2090  */
2091 gboolean
2092 gtk_assistant_get_page_complete (GtkAssistant *assistant,
2093                                  GtkWidget    *page)
2094 {
2095   GtkAssistantPage *page_info;
2096   GList *child;
2097
2098   g_return_val_if_fail (GTK_IS_ASSISTANT (assistant), FALSE);
2099   g_return_val_if_fail (GTK_IS_WIDGET (page), FALSE);
2100
2101   child = find_page (assistant, page);
2102
2103   g_return_val_if_fail (child != NULL, FALSE);
2104
2105   page_info = (GtkAssistantPage*) child->data;
2106
2107   return page_info->complete;
2108 }
2109
2110 /**
2111  * gtk_assistant_update_buttons_state:
2112  * @assistant: a #GtkAssistant
2113  *
2114  * Forces @assistant to recompute the buttons state.
2115  *
2116  * GTK+ automatically takes care of this in most situations,
2117  * e.g. when the user goes to a different page, or when the
2118  * visibility or completeness of a page changes.
2119  *
2120  * One situation where it can be necessary to call this
2121  * function is when changing a value on the current page
2122  * affects the future page flow of the assistant.
2123  *
2124  * Since: 2.10
2125  */
2126 void
2127 gtk_assistant_update_buttons_state (GtkAssistant *assistant)
2128 {
2129   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
2130
2131   update_buttons_state (assistant);
2132 }
2133
2134 /**
2135  * gtk_assistant_commit:
2136  * @assistant: a #GtkAssistant
2137  *
2138  * Erases the visited page history so the back button is not
2139  * shown on the current page, and removes the cancel button
2140  * from subsequent pages.
2141  *
2142  * Use this when the information provided up to the current
2143  * page is hereafter deemed permanent and cannot be modified
2144  * or undone. For example, showing a progress page to track
2145  * a long-running, unreversible operation after the user has
2146  * clicked apply on a confirmation page.
2147  *
2148  * Since: 2.22
2149  */
2150 void
2151 gtk_assistant_commit (GtkAssistant *assistant)
2152 {
2153   g_return_if_fail (GTK_IS_ASSISTANT (assistant));
2154
2155   g_slist_free (assistant->priv->visited_pages);
2156   assistant->priv->visited_pages = NULL;
2157
2158   assistant->priv->committed = TRUE;
2159
2160   update_buttons_state (assistant);
2161 }
2162
2163 static AtkObject *
2164 gtk_assistant_get_accessible (GtkWidget *widget)
2165 {
2166   static gboolean first_time = TRUE;
2167
2168   if (first_time)
2169     {
2170       _gtk_accessible_set_factory_type (GTK_TYPE_ASSISTANT,
2171                                         gtk_assistant_accessible_factory_get_type ());
2172
2173       first_time = FALSE;
2174     }
2175
2176   return GTK_WIDGET_CLASS (gtk_assistant_parent_class)->get_accessible (widget);
2177 }
2178
2179 /* accessible implementation */
2180
2181 /* dummy typedefs */
2182 typedef struct _GtkAssistantAccessible          GtkAssistantAccessible;
2183 typedef struct _GtkAssistantAccessibleClass     GtkAssistantAccessibleClass;
2184
2185 ATK_DEFINE_TYPE (GtkAssistantAccessible, _gtk_assistant_accessible, GTK_TYPE_ASSISTANT);
2186
2187 static gint
2188 gtk_assistant_accessible_get_n_children (AtkObject *accessible)
2189 {
2190   GtkWidget *widget;
2191
2192   widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
2193   if (widget == NULL)
2194     return 0;
2195
2196   return g_list_length (GTK_ASSISTANT (widget)->priv->pages) + 1;
2197 }
2198
2199 static AtkObject *
2200 gtk_assistant_accessible_ref_child (AtkObject *accessible,
2201                                     gint       index)
2202 {
2203   GtkAssistant *assistant;
2204   GtkAssistantPrivate *priv;
2205   GtkWidget *widget, *child;
2206   gint n_pages;
2207   AtkObject *obj;
2208   const gchar *title;
2209
2210   widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
2211   if (widget == NULL)
2212     return NULL;
2213
2214   assistant = GTK_ASSISTANT (widget);
2215   priv = assistant->priv;
2216   n_pages = g_list_length (priv->pages);
2217
2218   if (index < 0)
2219     return NULL;
2220   else if (index < n_pages)
2221     {
2222       GtkAssistantPage *page = g_list_nth_data (priv->pages, index);
2223
2224       child = page->page;
2225       title = gtk_assistant_get_page_title (assistant, child);
2226     }
2227   else if (index == n_pages)
2228     {
2229       child = priv->action_area;
2230       title = NULL;
2231     }
2232   else
2233     return NULL;
2234
2235   obj = gtk_widget_get_accessible (child);
2236
2237   if (title)
2238     atk_object_set_name (obj, title);
2239
2240   return g_object_ref (obj);
2241 }
2242
2243 static void
2244 _gtk_assistant_accessible_class_init (GtkAssistantAccessibleClass *klass)
2245 {
2246   AtkObjectClass *atk_class = ATK_OBJECT_CLASS (klass);
2247
2248   atk_class->get_n_children = gtk_assistant_accessible_get_n_children;
2249   atk_class->ref_child = gtk_assistant_accessible_ref_child;
2250 }
2251
2252 static void
2253 _gtk_assistant_accessible_init (GtkAssistantAccessible *self)
2254 {
2255 }
2256
2257 /* factory */
2258 typedef AtkObjectFactory        GtkAssistantAccessibleFactory;
2259 typedef AtkObjectFactoryClass   GtkAssistantAccessibleFactoryClass;
2260
2261 G_DEFINE_TYPE (GtkAssistantAccessibleFactory,
2262                gtk_assistant_accessible_factory,
2263                ATK_TYPE_OBJECT_FACTORY);
2264
2265 static GType
2266 gtk_assistant_accessible_factory_get_accessible_type (void)
2267 {
2268   return _gtk_assistant_accessible_get_type ();
2269 }
2270
2271 static AtkObject*
2272 gtk_assistant_accessible_factory_create_accessible (GObject *obj)
2273 {
2274   AtkObject *accessible;
2275
2276   accessible = g_object_new (_gtk_assistant_accessible_get_type (), NULL);
2277   atk_object_initialize (accessible, obj);
2278
2279   return accessible;
2280 }
2281
2282 static void
2283 gtk_assistant_accessible_factory_class_init (AtkObjectFactoryClass *class)
2284 {
2285   class->create_accessible = gtk_assistant_accessible_factory_create_accessible;
2286   class->get_accessible_type = gtk_assistant_accessible_factory_get_accessible_type;
2287 }
2288
2289 static void
2290 gtk_assistant_accessible_factory_init (AtkObjectFactory *factory)
2291 {
2292 }
2293
2294 /* buildable implementation */
2295
2296 static GtkBuildableIface *parent_buildable_iface;
2297
2298 static void
2299 gtk_assistant_buildable_interface_init (GtkBuildableIface *iface)
2300 {
2301   parent_buildable_iface = g_type_interface_peek_parent (iface);
2302   iface->get_internal_child = gtk_assistant_buildable_get_internal_child;
2303   iface->custom_tag_start = gtk_assistant_buildable_custom_tag_start;
2304   iface->custom_finished = gtk_assistant_buildable_custom_finished;
2305 }
2306
2307 static GObject *
2308 gtk_assistant_buildable_get_internal_child (GtkBuildable *buildable,
2309                                             GtkBuilder   *builder,
2310                                             const gchar  *childname)
2311 {
2312     if (strcmp (childname, "action_area") == 0)
2313       return G_OBJECT (GTK_ASSISTANT (buildable)->priv->action_area);
2314
2315     return parent_buildable_iface->get_internal_child (buildable,
2316                                                        builder,
2317                                                        childname);
2318 }
2319
2320 gboolean
2321 gtk_assistant_buildable_custom_tag_start (GtkBuildable  *buildable,
2322                                           GtkBuilder    *builder,
2323                                           GObject       *child,
2324                                           const gchar   *tagname,
2325                                           GMarkupParser *parser,
2326                                           gpointer      *data)
2327 {
2328   return parent_buildable_iface->custom_tag_start (buildable, builder, child,
2329                                                    tagname, parser, data);
2330 }
2331
2332 static void
2333 gtk_assistant_buildable_custom_finished (GtkBuildable *buildable,
2334                                          GtkBuilder   *builder,
2335                                          GObject      *child,
2336                                          const gchar  *tagname,
2337                                          gpointer      user_data)
2338 {
2339   parent_buildable_iface->custom_finished (buildable, builder, child,
2340                                            tagname, user_data);
2341 }