PrintSettings

A GtkPrintSettings object represents the settings of a print dialog in a system-independent way. The main use for this object is that once you’ve printed you can get a settings object that represents the settings the user chose, and the next time you print you can pass that object in so that the user doesn’t have to re-set all his settings.

Its also possible to enumerate the settings so that you can easily save the settings for the next time your app runs, or even store them in a document. The predefined keys try to use shared values as much as possible so that moving such a document between systems still works.

Printing support was added in GTK+ 2.10.

class PrintSettings : ObjectG {

GtkPrintSettings* gtkPrintSettings;

GtkPrintSettings* getPrintSettingsStruct(bool transferOwnership);

void* getStruct();

this(GtkPrintSettings* gtkPrintSettings, bool ownedRef);

static GType getType();

this(string fileName);

this(Variant variant);

this(KeyFile keyFile, string groupName);

PrintSettings copy();

alias foreac = foreach_;

void foreach_(GtkPrintSettingsFunc func, void* userData);

string get(string key);

bool getBool(string key);

bool getCollate();

string getDefaultSource();

string getDither();

double getDouble(string key);

double getDoubleWithDefault(string key, double def);

GtkPrintDuplex getDuplex();

string getFinishings();

int getInt(string key);

int getIntWithDefault(string key, int def);

double getLength(string key, GtkUnit unit);

string getMediaType();

int getNCopies();

int getNumberUp();

GtkNumberUpLayout getNumberUpLayout();

GtkPageOrientation getOrientation();

string getOutputBin();

GtkPageRange[] getPageRanges();

GtkPageSet getPageSet();

double getPaperHeight(GtkUnit unit);

PaperSize getPaperSize();

double getPaperWidth(GtkUnit unit);

GtkPrintPages getPrintPages();

string getPrinter();

double getPrinterLpi();

GtkPrintQuality getQuality();

int getResolution();

int getResolutionX();

int getResolutionY();

bool getReverse();

double getScale();

bool getUseColor();

bool hasKey(string key);

bool loadFile(string fileName);

bool loadKeyFile(KeyFile keyFile, string groupName);

void set(string key, string value);

void setBool(string key, bool value);

void setCollate(bool collate);

void setDefaultSource(string defaultSource);

void setDither(string dither);

void setDouble(string key, double value);

void setDuplex(GtkPrintDuplex duplex);

void setFinishings(string finishings);

void setInt(string key, int value);

void setLength(string key, double value, GtkUnit unit);

void setMediaType(string mediaType);

void setNCopies(int numCopies);

void setNumberUp(int numberUp);

void setNumberUpLayout(GtkNumberUpLayout numberUpLayout);

void setOrientation(GtkPageOrientation orientation);

void setOutputBin(string outputBin);

void setPageRanges(GtkPageRange[] pageRanges);

void setPageSet(GtkPageSet pageSet);

void setPaperHeight(double height, GtkUnit unit);

void setPaperSize(PaperSize paperSize);

void setPaperWidth(double width, GtkUnit unit);

void setPrintPages(GtkPrintPages pages);

void setPrinter(string printer);

void setPrinterLpi(double lpi);

void setQuality(GtkPrintQuality quality);

void setResolution(int resolution);

void setResolutionXy(int resolutionX, int resolutionY);

void setReverse(bool reverse);

void setScale(double scale);

void setUseColor(bool useColor);

bool toFile(string fileName);

Variant toGvariant();

void toKeyFile(KeyFile keyFile, string groupName);

void unset(string key);

}

Constructors

this this(GtkPrintSettings* gtkPrintSettings, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new #GtkPrintSettings object.
this this(string fileName): Reads the print settings from @file_name. Returns a new #GtkPrintSettings object with the restored settings, or %NULL if an error occurred. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError. See gtk_print_settings_to_file().
this this(Variant variant): Deserialize print settings from an a{sv} variant in the format produced by gtk_print_settings_to_gvariant().
this this(KeyFile keyFile, string groupName): Reads the print settings from the group @group_name in @key_file. Returns a new #GtkPrintSettings object with the restored settings, or %NULL if an error occurred. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError.

Members

Aliases

foreac alias foreac = foreach_: Undocumented in source.

Functions

copy PrintSettings copy(): Copies a #GtkPrintSettings object.
foreach_ void foreach_(GtkPrintSettingsFunc func, void* userData): Calls @func for each key-value pair of @settings.
get string get(string key): Looks up the string value associated with @key.
getBool bool getBool(string key): Returns the boolean represented by the value that is associated with @key.
getCollate bool getCollate(): Gets the value of %GTK_PRINT_SETTINGS_COLLATE.
getDefaultSource string getDefaultSource(): Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
getDither string getDither(): Gets the value of %GTK_PRINT_SETTINGS_DITHER.
getDouble double getDouble(string key): Returns the double value associated with @key, or 0.
getDoubleWithDefault double getDoubleWithDefault(string key, double def): Returns the floating point number represented by the value that is associated with @key, or @default_val if the value does not represent a floating point number.
getDuplex GtkPrintDuplex getDuplex(): Gets the value of %GTK_PRINT_SETTINGS_DUPLEX.
getFinishings string getFinishings(): Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
getInt int getInt(string key): Returns the integer value of @key, or 0.
getIntWithDefault int getIntWithDefault(string key, int def): Returns the value of @key, interpreted as an integer, or the default value.
getLength double getLength(string key, GtkUnit unit): Returns the value associated with @key, interpreted as a length. The returned value is converted to @units.
getMediaType string getMediaType(): Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.
getNCopies int getNCopies(): Gets the value of %GTK_PRINT_SETTINGS_N_COPIES.
getNumberUp int getNumberUp(): Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
getNumberUpLayout GtkNumberUpLayout getNumberUpLayout(): Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
getOrientation GtkPageOrientation getOrientation(): Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, converted to a #GtkPageOrientation.
getOutputBin string getOutputBin(): Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
getPageRanges GtkPageRange[] getPageRanges(): Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
getPageSet GtkPageSet getPageSet(): Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
getPaperHeight double getPaperHeight(GtkUnit unit): Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT, converted to @unit.
getPaperSize PaperSize getPaperSize(): Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a #GtkPaperSize.
getPaperWidth double getPaperWidth(GtkUnit unit): Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH, converted to @unit.
getPrintPages GtkPrintPages getPrintPages(): Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
getPrintSettingsStruct GtkPrintSettings* getPrintSettingsStruct(bool transferOwnership): Get the main Gtk struct
getPrinter string getPrinter(): Convenience function to obtain the value of %GTK_PRINT_SETTINGS_PRINTER.
getPrinterLpi double getPrinterLpi(): Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
getQuality GtkPrintQuality getQuality(): Gets the value of %GTK_PRINT_SETTINGS_QUALITY.
getResolution int getResolution(): Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION.
getResolutionX int getResolutionX(): Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X.
getResolutionY int getResolutionY(): Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y.
getReverse bool getReverse(): Gets the value of %GTK_PRINT_SETTINGS_REVERSE.
getScale double getScale(): Gets the value of %GTK_PRINT_SETTINGS_SCALE.
getStruct void* getStruct(): the main Gtk struct as a void*
getUseColor bool getUseColor(): Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
hasKey bool hasKey(string key): Returns %TRUE, if a value is associated with @key.
loadFile bool loadFile(string fileName): Reads the print settings from @file_name. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError. See gtk_print_settings_to_file().
loadKeyFile bool loadKeyFile(KeyFile keyFile, string groupName): Reads the print settings from the group @group_name in @key_file. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError.
set void set(string key, string value): Associates @value with @key.
setBool void setBool(string key, bool value): Sets @key to a boolean value.
setCollate void setCollate(bool collate): Sets the value of %GTK_PRINT_SETTINGS_COLLATE.
setDefaultSource void setDefaultSource(string defaultSource): Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
setDither void setDither(string dither): Sets the value of %GTK_PRINT_SETTINGS_DITHER.
setDouble void setDouble(string key, double value): Sets @key to a double value.
setDuplex void setDuplex(GtkPrintDuplex duplex): Sets the value of %GTK_PRINT_SETTINGS_DUPLEX.
setFinishings void setFinishings(string finishings): Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
setInt void setInt(string key, int value): Sets @key to an integer value.
setLength void setLength(string key, double value, GtkUnit unit): Associates a length in units of @unit with @key.
setMediaType void setMediaType(string mediaType): Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.
setNCopies void setNCopies(int numCopies): Sets the value of %GTK_PRINT_SETTINGS_N_COPIES.
setNumberUp void setNumberUp(int numberUp): Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
setNumberUpLayout void setNumberUpLayout(GtkNumberUpLayout numberUpLayout): Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
setOrientation void setOrientation(GtkPageOrientation orientation): Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION.
setOutputBin void setOutputBin(string outputBin): Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
setPageRanges void setPageRanges(GtkPageRange[] pageRanges): Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
setPageSet void setPageSet(GtkPageSet pageSet): Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
setPaperHeight void setPaperHeight(double height, GtkUnit unit): Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT.
setPaperSize void setPaperSize(PaperSize paperSize): Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, %GTK_PRINT_SETTINGS_PAPER_WIDTH and %GTK_PRINT_SETTINGS_PAPER_HEIGHT.
setPaperWidth void setPaperWidth(double width, GtkUnit unit): Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH.
setPrintPages void setPrintPages(GtkPrintPages pages): Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
setPrinter void setPrinter(string printer): Convenience function to set %GTK_PRINT_SETTINGS_PRINTER to @printer.
setPrinterLpi void setPrinterLpi(double lpi): Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
setQuality void setQuality(GtkPrintQuality quality): Sets the value of %GTK_PRINT_SETTINGS_QUALITY.
setResolution void setResolution(int resolution): Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y.
setResolutionXy void setResolutionXy(int resolutionX, int resolutionY): Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y.
setReverse void setReverse(bool reverse): Sets the value of %GTK_PRINT_SETTINGS_REVERSE.
setScale void setScale(double scale): Sets the value of %GTK_PRINT_SETTINGS_SCALE.
setUseColor void setUseColor(bool useColor): Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
toFile bool toFile(string fileName): This function saves the print settings from @settings to @file_name. If the file could not be loaded then error is set to either a #GFileError or #GKeyFileError.
toGvariant Variant toGvariant(): Serialize print settings to an a{sv} variant.
toKeyFile void toKeyFile(KeyFile keyFile, string groupName): This function adds the print settings from @settings to @key_file.
unset void unset(string key): Removes any value associated with @key. This has the same effect as setting the value to %NULL.

Static functions

getType GType getType()

Variables

gtkPrintSettings GtkPrintSettings* gtkPrintSettings;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
isGcRoot bool isGcRoot;: Undocumented in source.
signals DClosure[gulong] signals;: Undocumented in source.
destroyNotify void destroyNotify(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify void toggleNotify(ObjectG obj, GObject* object, int isLastRef): Undocumented in source. Be warned that the author may not have intended to support it.
~this ~this(): Undocumented in source.
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
removeGcRoot void removeGcRoot(): Undocumented in source. Be warned that the author may not have intended to support it.
setProperty void setProperty(string propertyName, T value)
unref deprecated void unref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
doref deprecated ObjectG doref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): Creates a binding between @source_property on @source and @target_property on @target. Whenever the @source_property is changed the @target_property is updated using the same value. For instance:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom): Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by the binding.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
freezeNotify void freezeNotify(): Increases the freeze count on @object. If the freeze count is non-zero, the emission of "notify" signals on @object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, Value[] values): Gets @n_properties properties for an @object. Obtained properties will be set to @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether @object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property @property_name on @object.
notifyByPspec void notifyByPspec(ParamSpec pspec): Emits a "notify" signal for the property specified by @pspec on @object.
doref alias doref = ref_: Undocumented in source.
ref_ ObjectG ref_(): Increases the reference count of @object.
refSink ObjectG refSink(): Increase the reference count of @object, and possibly remove the floating[floating-ref] reference, if @object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata() and removes the @data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example: |[ void object_add_to_user_list (GObject *object, const gchar *new_string) { // the quark, naming the object data GQuark quark_string_list = g_quark_from_static_string ("my-string-list"); // retrive the old string list GList *list = g_object_steal_qdata (object, quark_string_list);
thawNotify void thawNotify(): Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted.
unref void unref(): Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(Closure closure): This function essentially limits the life time of the @closure to the life time of the object. That is, when the object is finalized, the @closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the @closure. Usually, this function will be called on closures that use this @object as closure data.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a #GObject.

Meta

Source

See Implementation

gtk PrintSettings classes

PrintSettings