PageSetup

A gtk.page_setup.PageSetup object stores the page size, orientation and margins.

The idea is that you can get one of these from the page setup dialog and then pass it to the gtk.print_operation.PrintOperation when printing. The benefit of splitting this out of the gtk.print_settings.PrintSettings is that these affect the actual layout of the page, and thus need to be set long before user prints.

Margins

The margins specified in this object are the “print margins”, i.e. the parts of the page that the printer cannot print on. These are different from the layout margins that a word processor uses; they are typically used to determine the minimal size for the layout margins.

To obtain a gtk.page_setup.PageSetup use gtk.page_setup.PageSetup.new_ to get the defaults, or use func@Gtk.print_run_page_setup_dialog to show the page setup dialog and receive the resulting page setup.

A page setup dialog

static GtkPrintSettings *settings = NULL;
static GtkPageSetup *page_setup = NULL;

static void
do_page_setup (void)
{
  GtkPageSetup *new_page_setup;

  if (settings == NULL)
    settings = gtk_print_settings_new ();

  new_page_setup = gtk_print_run_page_setup_dialog (GTK_WINDOW (main_window),
                                                    page_setup, settings);

  if (page_setup)
    g_object_unref (page_setup);

  page_setup = new_page_setup;
}

class PageSetup : ObjectG {

this();

static gtk.page_setup.PageSetup newFromFile(string fileName);

static gtk.page_setup.PageSetup newFromGvariant(glib.variant.VariantG variant);

static gtk.page_setup.PageSetup newFromKeyFile(glib.key_file.KeyFile keyFile, string groupName);

gtk.page_setup.PageSetup copy();

double getBottomMargin(gtk.types.Unit unit);

double getLeftMargin(gtk.types.Unit unit);

gtk.types.PageOrientation getOrientation();

double getPageHeight(gtk.types.Unit unit);

double getPageWidth(gtk.types.Unit unit);

double getPaperHeight(gtk.types.Unit unit);

gtk.paper_size.PaperSize getPaperSize();

double getPaperWidth(gtk.types.Unit unit);

double getRightMargin(gtk.types.Unit unit);

double getTopMargin(gtk.types.Unit unit);

bool loadFile(string fileName);

bool loadKeyFile(glib.key_file.KeyFile keyFile, string groupName);

void setBottomMargin(double margin, gtk.types.Unit unit);

void setLeftMargin(double margin, gtk.types.Unit unit);

void setOrientation(gtk.types.PageOrientation orientation);

void setPaperSize(gtk.paper_size.PaperSize size);

void setPaperSizeAndDefaultMargins(gtk.paper_size.PaperSize size);

void setRightMargin(double margin, gtk.types.Unit unit);

void setTopMargin(double margin, gtk.types.Unit unit);

bool toFile(string fileName);

glib.variant.VariantG toGvariant();

void toKeyFile(glib.key_file.KeyFile keyFile, string groupName);

}

Constructors

this this(): Creates a new gtk.page_setup.PageSetup.

Members

Functions

copy gtk.page_setup.PageSetup copy(): Copies a gtk.page_setup.PageSetup.
getBottomMargin double getBottomMargin(gtk.types.Unit unit): Gets the bottom margin in units of unit.
getLeftMargin double getLeftMargin(gtk.types.Unit unit): Gets the left margin in units of unit.
getOrientation gtk.types.PageOrientation getOrientation(): Gets the page orientation of the gtk.page_setup.PageSetup.
getPageHeight double getPageHeight(gtk.types.Unit unit): Returns the page height in units of unit.
getPageWidth double getPageWidth(gtk.types.Unit unit): Returns the page width in units of unit.
getPaperHeight double getPaperHeight(gtk.types.Unit unit): Returns the paper height in units of unit.
getPaperSize gtk.paper_size.PaperSize getPaperSize(): Gets the paper size of the gtk.page_setup.PageSetup.
getPaperWidth double getPaperWidth(gtk.types.Unit unit): Returns the paper width in units of unit.
getRightMargin double getRightMargin(gtk.types.Unit unit): Gets the right margin in units of unit.
getTopMargin double getTopMargin(gtk.types.Unit unit): Gets the top margin in units of unit.
loadFile bool loadFile(string fileName): Reads the page setup from the file file_name.
loadKeyFile bool loadKeyFile(glib.key_file.KeyFile keyFile, string groupName): Reads the page setup from the group group_name in the key file key_file.
setBottomMargin void setBottomMargin(double margin, gtk.types.Unit unit): Sets the bottom margin of the gtk.page_setup.PageSetup.
setLeftMargin void setLeftMargin(double margin, gtk.types.Unit unit): Sets the left margin of the gtk.page_setup.PageSetup.
setOrientation void setOrientation(gtk.types.PageOrientation orientation): Sets the page orientation of the gtk.page_setup.PageSetup.
setPaperSize void setPaperSize(gtk.paper_size.PaperSize size): Sets the paper size of the gtk.page_setup.PageSetup without changing the margins.
setPaperSizeAndDefaultMargins void setPaperSizeAndDefaultMargins(gtk.paper_size.PaperSize size): Sets the paper size of the gtk.page_setup.PageSetup and modifies the margins according to the new paper size.
setRightMargin void setRightMargin(double margin, gtk.types.Unit unit): Sets the right margin of the gtk.page_setup.PageSetup.
setTopMargin void setTopMargin(double margin, gtk.types.Unit unit): Sets the top margin of the gtk.page_setup.PageSetup.
toFile bool toFile(string fileName): This function saves the information from setup to file_name.
toGvariant glib.variant.VariantG toGvariant(): Serialize page setup to an a{sv} variant.
toKeyFile void toKeyFile(glib.key_file.KeyFile keyFile, string groupName): This function adds the page setup from setup to key_file.

Static functions

newFromFile gtk.page_setup.PageSetup newFromFile(string fileName): Reads the page setup from the file file_name.
newFromGvariant gtk.page_setup.PageSetup newFromGvariant(glib.variant.VariantG variant): Desrialize a page setup from an a{sv} variant.
newFromKeyFile gtk.page_setup.PageSetup newFromKeyFile(glib.key_file.KeyFile keyFile, string groupName): Reads the page setup from the group group_name in the key file key_file.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.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.
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 gobject.object.ObjectG.refSink.
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 gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.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(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
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.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
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(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata 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:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.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 gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.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.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtk page_setup classes

PageSetup