GnomeScanDialog

GnomeScanDialog — A scan configuration UI container

Synopsis




            GnomeScanDialog;
GtkWidget*  gnome_scan_dialog_new           (GnomeScanContext *context,
                                             GtkWindow *parent);
void        gnome_scan_dialog_run           (GnomeScanDialog *dialog);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GtkDialog
                                             +----GnomeScanDialog

Implemented Interfaces

GnomeScanDialog implements AtkImplementorIface.

Properties


  "context"              GnomeScanContext      : Read / Write

Description

The GnomeScanDialog widget allow the application to compose a scan configuration UI. This way, each application has the power to choose what they want the user to configure and what they don't want to. This is a key feature since scanner has a lot of use from simple picture scan to OCR.

Application first instanciate the GnomeScanContext. Preconfigure it as wanted. Then build the scan configuration UI passing the GnomeScanContext to each GnomeScan widget. Then pass the UI to a GnomeScanDialog and run the GnomeScanDialog using gnome_scan_dialog_run(). When user has finished to configure the scan, he just validate the scan configuration and then, the acquisition start. See GnomeScanAcquisitionDialog for further information on the second step.

Details

GnomeScanDialog

typedef struct {
  GnomeScanContext*		context;
} GnomeScanDialog;


gnome_scan_dialog_new ()

GtkWidget*  gnome_scan_dialog_new           (GnomeScanContext *context,
                                             GtkWindow *parent);

Create a new GnomeScanDialog connnected to context. If parent is not NULL, then the new dialog will be transient for parent. ui is the widget tree containing configuration widget showed in the body of the GnomeScanDialog.

context : a GnomeScanContext
parent : a GtkWidget or NULL
Returns : a new GnomeScanDialog

gnome_scan_dialog_run ()

void        gnome_scan_dialog_run           (GnomeScanDialog *dialog);

Run the dialog waiting for the use to configure the scan and trigger acquisition.

dialog : a GnomeScanDialog

Property Details

The "context" property

  "context"              GnomeScanContext      : Read / Write

A GnomeScanContext the widget is connected to.