Struct poppler::Page

pub struct Page { /* private fields */ }

Properties

label

The label of the page or None. See also Page::label()

Readable

GLib type: GObject with reference counted clone semantics.

Implementations

impl Page

pub fn add_annot(&self, annot: &impl IsA<Annot>)

Adds annotation annot to self.

annot

a Annot to add

pub fn find_text(&self, text: &str) -> Vec<Rectangle>

Finds text in self with the default options (FindFlags::DEFAULT) and returns a GList of rectangles for each occurrence of the text on the page. The coordinates are in PDF points.

text

the text to search for (UTF-8 encoded)

Returns

a GList of Rectangle,

pub fn find_text_with_options( &self, text: &str, options: FindFlags, ) -> Vec<Rectangle>

Finds text in self with the given FindFlags options and returns a GList of rectangles for each occurrence of the text on the page. The coordinates are in PDF points.

When FindFlags::MULTILINE is passed in options, matches may span more than one line. In this case, the returned list will contain one Rectangle for each part of a match. The function Rectangle::find_get_match_continued() will return true for all rectangles belonging to the same match, except for the last one. If a hyphen was ignored at the end of the part of the match, Rectangle::find_get_ignored_hyphen() will return true for that rectangle.

Note that currently matches spanning more than two lines are not found. (This limitation may be lifted in a future version.)

Note also that currently finding multi-line matches backwards is not implemented; if you pass FindFlags::BACKWARDS and FindFlags::MULTILINE together, FindFlags::MULTILINE will be ignored.

text

the text to search for (UTF-8 encoded)

options

find options

Returns

a newly allocated list of newly allocated Rectangle. Free with g_list_free_full() using poppler_rectangle_free().

pub fn annot_mapping(&self) -> Vec<AnnotMapping>

Returns a list of AnnotMapping items that map from a location on self to a Annot. This list must be freed with poppler_page_free_annot_mapping() when done.

Returns

A GList of AnnotMapping

pub fn get_bounding_box(&self, rect: &mut Rectangle) -> bool

pub fn duration(&self) -> f64

Returns the duration of self

Returns

duration in seconds of self or -1.

pub fn form_field_mapping(&self) -> Vec<FormFieldMapping>

Returns a list of FormFieldMapping items that map from a location on self to a form field. This list must be freed with poppler_page_free_form_field_mapping() when done.

Returns

A GList of FormFieldMapping

pub fn image(&self, image_id: i32) -> Option<Surface>

Returns a cairo surface for the image of the self

image_id

The image identifier

Returns

A cairo surface for the image

pub fn image_mapping(&self) -> Vec<ImageMapping>

Returns a list of ImageMapping items that map from a location on self to an image of the page. This list must be freed with poppler_page_free_image_mapping() when done.

Returns

A GList of ImageMapping

pub fn index(&self) -> i32

Returns the index of self

Returns

index value of self

pub fn label(&self) -> Option<GString>

Returns the label of self. Note that page labels and page indices might not coincide.

Returns

a new allocated string containing the label of self, or None if self doesn’t have a label

pub fn link_mapping(&self) -> Vec<LinkMapping>

Returns a list of LinkMapping items that map from a location on self to a PopplerAction. This list must be freed with poppler_page_free_link_mapping() when done.

Returns

A GList of LinkMapping

pub fn selected_region( &self, scale: f64, style: SelectionStyle, selection: &mut Rectangle, ) -> Option<Region>

Returns a region containing the area that would be rendered by render_selection(). The returned region must be freed with cairo_region_destroy()

scale

scale specified as pixels per point

style

a SelectionStyle

selection

start and end point of selection as a rectangle

Returns

a cairo_region_t

pub fn selected_text( &self, style: SelectionStyle, selection: &mut Rectangle, ) -> Option<GString>

Retrieves the contents of the specified selection as text.

style

a SelectionStyle

selection

the Rectangle including the text

Returns

a pointer to the contents of the selection as a string

pub fn size(&self) -> (f64, f64)

Gets the size of self at the current scale and rotation.

Returns

width

return location for the width of self

height

return location for the height of self

pub fn text(&self) -> Option<GString>

Retrieves the text of self.

Returns

a pointer to the text of the self as a string

pub fn text_attributes(&self) -> Vec<TextAttributes>

Obtains the attributes of the text as a GList of TextAttributes. This list must be freed with poppler_page_free_text_attributes() when done.

Each list element is a TextAttributes struct where start_index and end_index indicates the range of text (as returned by text()) to which text attributes apply.

See also text_attributes_for_area()

Returns

A GList of TextAttributes

pub fn text_attributes_for_area( &self, area: &mut Rectangle, ) -> Vec<TextAttributes>

Obtains the attributes of the text in area as a GList of TextAttributes. This list must be freed with poppler_page_free_text_attributes() when done.

Each list element is a TextAttributes struct where start_index and end_index indicates the range of text (as returned by text_for_area()) to which text attributes apply.

area

a Rectangle

Returns

A GList of TextAttributes

pub fn text_for_area(&self, area: &mut Rectangle) -> Option<GString>

Retrieves the text of self contained in area.

area

a Rectangle

Returns

a pointer to the text as a string

pub fn thumbnail(&self) -> Option<Surface>

Get the embedded thumbnail for the specified page. If the document doesn’t have an embedded thumbnail for the page, this function returns None.

Returns

the tumbnail as a cairo_surface_t or None if the document doesn’t have a thumbnail for this page.

pub fn thumbnail_size(&self) -> Option<(i32, i32)>

Returns true if self has a thumbnail associated with it. It also fills in width and height with the width and height of the thumbnail. The values of width and height are not changed if no appropriate thumbnail exists.

Returns

true, if self has a thumbnail associated with it.

width

return location for width

height

return location for height

pub fn transition(&self) -> Option<PageTransition>

Returns the transition effect of self

Returns

a PageTransition or None.

pub fn remove_annot(&self, annot: &impl IsA<Annot>)

Removes annotation annot from self

annot

a Annot to remove

pub fn render(&self, cairo: &Context)

Render the page to the given cairo context. This function is for rendering a page that will be displayed. If you want to render a page that will be printed use render_for_printing() instead. Please see the documentation for that function for the differences between rendering to the screen and rendering to a printer.

cairo

cairo context to render to

pub fn render_for_printing(&self, cairo: &Context)

Render the page to the given cairo context for printing with PrintFlags::ALL flags selected. If you want a different set of flags, use render_for_printing_with_options().

The difference between render() and this function is that some things get rendered differently between screens and printers:

<itemizedlist> <listitem> PDF annotations get rendered according to their AnnotFlag value. For example, AnnotFlag::PRINT refers to whether an annotation is printed or not, whereas AnnotFlag::NO_VIEW refers to whether an annotation is invisible when displaying to the screen. </listitem> <listitem> PDF supports “hairlines” of width 0.0, which often get rendered as having a width of 1 device pixel. When displaying on a screen, Cairo may render such lines wide so that they are hard to see, and Poppler makes use of PDF’s Stroke Adjust graphics parameter to make the lines easier to see. However, when printing, Poppler is able to directly use a printer’s pixel size instead. </listitem> <listitem> Some advanced features in PDF may require an image to be rasterized before sending off to a printer. This may produce raster images which exceed Cairo’s limits. The “printing” functions will detect this condition and try to down-scale the intermediate surfaces as appropriate. </listitem> </itemizedlist>

cairo

cairo context to render to

pub fn render_for_printing_with_options( &self, cairo: &Context, options: PrintFlags, )

Render the page to the given cairo context for printing with the specified options

See the documentation for render_for_printing() for the differences between rendering to the screen and rendering to a printer.

cairo

cairo context to render to

options

print options

pub fn render_selection( &self, cairo: &Context, selection: &mut Rectangle, old_selection: &mut Rectangle, style: SelectionStyle, glyph_color: &mut Color, background_color: &mut Color, )

Render the selection specified by selection for self to the given cairo context. The selection will be rendered, using glyph_color for the glyphs and background_color for the selection background.

If non-NULL, old_selection specifies the selection that is already rendered to cairo, in which case this function will (some day) only render the changed part of the selection.

cairo

cairo context to render to

selection

start and end point of selection as a rectangle

old_selection

previous selection

style

a SelectionStyle

glyph_color

color to use for drawing glyphs

background_color

color to use for the selection background

pub fn render_to_ps(&self, ps_file: &PSFile)

Render the page on a postscript file

ps_file

the PopplerPSFile to render to

pub fn connect_label_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for Page

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Page

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Page

type ParamSpec = ParamSpecObject

type SetValue = Page

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Page>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Page

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Page

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Page

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Page

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Page

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Page

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Page