poppler::page Class Reference

A page in a PDF document. More...

#include "poppler/cpp/poppler-page.h"

Inheritance diagram for poppler::page:
[legend]

List of all members.

Public Types

enum  orientation_enum {
  landscape,
  portrait,
  seascape,
  upside_down
}
enum  search_direction_enum {
  search_from_top,
  search_next_result,
  search_previous_result
}
enum  text_layout_enum {
  physical_layout,
  raw_order_layout
}

Public Member Functions

 ~page ()
double duration () const
ustring label () const
orientation_enum orientation () const
rectf page_rect (page_box_enum box=crop_box) const
bool search (const ustring &text, rectf &r, search_direction_enum direction, case_sensitivity_enum case_sensitivity, rotation_enum rotation=rotate_0) const
ustring text (const rectf &rect, text_layout_enum layout_mode) const
ustring text (const rectf &rect=rectf()) const
page_transitiontransition () const

Detailed Description

A page in a PDF document.


Member Enumeration Documentation

The possible orientation of a page.

The direction/action to follow when performing a text search.

A layout of the text of a page.


Constructor & Destructor Documentation

page::~page (  ) 

Destructor.


Member Function Documentation

double page::duration (  )  const

The eventual duration the page can be hinted to be shown in a presentation.

If this value is positive (usually different than -1) then a PDF viewer, when showing the page in a presentation, should show the page for at most for this number of seconds, and then switch to the next page (if any). Note this is purely a presentation attribute, it has no influence on the behaviour.

Returns:
the duration time (in seconds) of the page
ustring page::label (  )  const
Returns:
the label of the page, if any
page::orientation_enum page::orientation (  )  const
Returns:
the orientation of the page
rectf page::page_rect ( page_box_enum  box = crop_box  )  const

Returns the size of one rect of the page.

Returns:
the size of the specified page rect
bool page::search ( const ustring text,
rectf r,
search_direction_enum  direction,
case_sensitivity_enum  case_sensitivity,
rotation_enum  rotation = rotate_0 
) const

Search the page for some text.

Parameters:
text the text to search
[in,out] r the area where to start search, which will be set to the area of the match (if any)
direction in which direction search for text
case_sensitivity whether search in a case sensitive way
rotation the rotation assumed for the page
ustring page::text ( const rectf r,
text_layout_enum  layout_mode 
) const

Returns the text in the page.

Parameters:
rect if not empty, it will be extracted the text in it; otherwise, the text of the whole page
layout_mode the layout of the text
Returns:
the text of the page in the specified rect or in the whole page
Since:
0.16
ustring page::text ( const rectf r = rectf()  )  const

Returns the text in the page, in its physical layout.

Parameters:
r if not empty, it will be extracted the text in it; otherwise, the text of the whole page
Returns:
the text of the page in the specified rect or in the whole page
page_transition * page::transition (  )  const

The transition from this page to the next one.

If it is set, then a PDF viewer in a presentation should perform the specified transition effect when switching from this page to the next one.

Returns:
the transition effect for the switch to the next page, if any

Generated on 27 Dec 2015 for Poppler CPP by  doxygen 1.6.1