Package ch.bailu.gtk.gtk

Interface PrintOperation.OnPaginate

Enclosing class:
PrintOperation
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public static interface PrintOperation.OnPaginate

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    onPaginate(PrintContext context)
    Emitted after the ::begin-print signal, but before the actual rendering
    starts.

  • Method Details

    • onPaginate

      boolean onPaginate(@Nonnull PrintContext context)
      Emitted after the ::begin-print signal, but before the actual rendering
      starts.

      It keeps getting emitted until a connected signal handler returns %TRUE.

      The ::paginate signal is intended to be used for paginating a document
      in small chunks, to avoid blocking the user interface for a long
      time. The signal handler should update the number of pages using
      [method@Gtk.PrintOperation.set_n_pages], and return %TRUE if the document
      has been completely paginated.

      If you don't need to do pagination in chunks, you can simply do
      it all in the ::begin-print handler, and set the number of pages
      from there.
      Parameters:
      context - the `GtkPrintContext` for the current operation
      Returns:
      %TRUE if pagination is complete