Documentation‎ > ‎Toplevel Windows‎ > ‎

    gnocl::assistant

    A widget used to guide the user through a number of steps in order to complete a specific task.

    NOTE: PAGE STILL IN PROGRESS

    Synopsis

    gnocl::assistant [-option value...]

    The command returns the name of the newly created gnocl::assistant widget

    Options

    -linear boolean (default:: 0)

    Not certain what this does anymore!

    -onApply string (default: "")
    Tcl script which is executed when the assistant "Apply" button is clicked.  The script called at this point should carry out the actions for which the assistant has gathered data. Before evaluation the following percent strings are substituted:

    %w   widget name
    %n    page number
    -onCancel string (default: "")
    Tcl script which is executed when the assistant "Cancel" button is clicked. Before evaluation the following percent strings are substituted:

    %w   widget name
    %n    page number
    -onClose string (default: "")
    Tcl script which is executed when the assistant "Close" button of a summary page is clicked or when the "Apply" button in the last page in the flow is clicked. Before evaluation the following percent strings are substituted:

    %w   widget name
    %n    page number
    -onPrepare string (default: "")
    Tcl script which is executed when a new page is set as the assistan widgets current page. The script will be executed before making the new page visible to allow preparation of the page priot to its display. Before evaluation the following percent strings are substituted:

    %w   widget name
    %n    page number
    %p
       page child widget
    -defaultHeight integer
    Default height of the window.
    -defaultWidth integer
    Default width of the window.
    -heightRequest integer
    Requested height of the window.
    -title string (default: "")
    Title of the window.
    -resizable boolean (default: 1)
    Whether the user can change the size of the window.
    -transient string (default: "")
    Specify window as a child window for the toplevel container of the calling widget.
    -keepAbove  boolean (default: 0)
    Whether or not to keep this window topmost in the window rendering z-stack.
    -icon percent-string (default: "")
    Sets the icon of the window which is shown, depending on the window manager, in the window decoration, the window list, and/or if the window is iconified. This must be either a file name (prefix "%/") or empty.

    -backgroundImage

    Set background image of the widget.

    -modal boolean (default: 0)
    Whether the window is modal, i.e. it grabs all GTK+ events.

    -backgroundColor color

    Set default colour for the background of this widget.

    -data string (default: "")
    User defined data which can be retrieved via the cget subcommand.
    -name string (default: "")
    Name of the widget, can be used to set options in an rc file.

    -keepAbove string (default: "")

    Description goes here.

    -icon percent-string (default: "")
    Sets the icon of the window which is shown, depending on the window manager, in the window decoration, the window list, and/or if the window is iconified. This must be either a file name (prefix "%/") or empty.

    -backgroundImage string (default: "")

    Description goes here.

    -modal boolean (default: 0)
    Whether the window is modal, i.e. it grabs all GTK+ events.

    -backgroundColor string (default: "")

    Description goes here.

    -onDelete string (default: "")
    Tcl command which is executed if the widget shall be deleted. If the command returns 0, the widget is not deleted. Before evaluation the following percent strings are substituted:

    %w    widget name
    -onDestroy string (default: "")
    Tcl command which is executed if the widget is destroyed. Before evaluation the following percent strings are substituted:

    %w    widget name

    Description

    A gnocl::assistant widget used to represent a generally complex operation splitted in several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.

    Commands

    id add text ?option?
    Adds the given text to the current item list.
    id cget option
    Returns the value for one option. The option may have any of the values accepted by configure.
    id configure [-option value...]
    Configures the widget. Option may have any of the values accepted on creation of the widget.
    id delete
    Deletes the widget and the associated Tcl command.
    id page ?option?

    Sub-Commands

    set id

    configure id ?option?

    id addPage pagetype ?option?

    Page Types

    contents

    The page has regular contents.

    introduction

    The page contains an introduction to the assistant task.

    confirm

    The page lets the user confirm or deny the changes..

    summary

    The page informs the user of the changes done.

    progress

    Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete.

    Page Properties

       -complete boolean (default:"")

    Sets whether page contents are complete. This will make assistant update the buttons state to be able to continue the task.

       -headerImage string (default:"")

    Sets a header image for page. This image is displayed in the header area of the assistant when page is the current page.

       -sideImage string (default:"")

      Sets a header image for page. This image is displayed in the side area of the assistant when page is the current page.

       -type string (default:"")

    An enum for determining the page role inside the GtkAssistant. It's used to handle buttons sensitivity and visibility. One of content, intro, confirm, summary or progress.

       -title string (default:"")

    Sets a title for page. The title is displayed in the header area of the assistant when page is the current page.

    id insertPage ?option?

    CURRENTLY UNDER DEVELOPMENT/REVIEW -DO NOT USE.

    id currentPage

    Return the current page number in the sequence.

    id pages

    Return the total number of pages in the assistant sequence.


    id
    addWidget ?option?

    DESCRIPTION TO BE ADDED.

    id removeWidget ?option?

    DESCRIPTION TO BE ADDED.

    id update ?option?

    DESCRIPTION TO BE ADDED.

    Comments

    Sections