Struct poppler::StructureElement

#[repr(transparent)]
pub struct StructureElement { /* private fields */ }

Implementations

impl StructureElement

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

Acronyms and abbreviations contained in elements of type StructureElementKind::Span may have an associated expanded text form, which can be retrieved using this function.

Returns

Text of the expanded abbreviation if the element text is an abbreviation or acrony, None if not.

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

Obtains the actual text enclosed by the element (and its child elements). The actual text is mostly used for non-text elements like images and figures which <emphasis>do</emphasis> have the graphical appearance of text, like a logo. For those the actual text is the equivalent text to those graphical elements which look like text when rendered.

Note that for elements containing proper text, the function text() must be used instead.

Returns

The actual text for the element, or None if not defined.

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

Obtains the “alternate” text representation of the element (and its child elements). This is mostly used for non-text elements like images and figures, to specify a textual description of the element.

Note that for elements containing proper text, the function text() must be used instead.

Returns

The alternate text representation for the element, or None if not defined.

pub fn background_color(&self) -> Option<Color>

Obtains the background color of the element. If this attribute is not specified, the element shall be treated as if it were transparent.

Returns

true if a color is defined for the element, false otherwise.

color

A Color.

pub fn baseline_shift(&self) -> f64

Obtains how much the text contained in the inline-level structure element should be shifted, measuring from the baseline of the glyphs.

Returns

A numeric value.

pub fn block_align(&self) -> StructureBlockAlign

Obtains the block-alignment mode of the block-level structure element.

Returns

A StructureBlockAlign value.

pub fn bounding_box(&self) -> Option<Rectangle>

Obtains the size of the bounding box of a block-level structure element.

Returns

true if a bounding box is defined for the element, false otherwise.

bounding_box

A Rectangle.

pub fn color(&self) -> Option<Color>

Obtains the color of the content contained in the element. If this attribute is not specified, the color for this element shall be the current text fill color in effect at the start of its associated content.

Returns

true if a color is defined for the element, false otherwise.

color

A Color.

pub fn column_count(&self) -> u32

Obtains the number of columns used to lay out the content contained in the grouping element.

Returns

Number of columns.

pub fn column_gaps(&self) -> Vec<f64>

Obtains the size of the gaps in between adjacent columns. Returns an array of elements: the first one is the size of the gap in between columns 1 and 2, second is the size between columns 2 and 3, and so on.

For elements which use a single column, None is returned and n_values is set to zero.

If the attribute is undefined, None is returned and n_values is set to a non-zero value.

The array with the results is allocated by the function. When it is not needed anymore, be sure to call g_free() on it.

Returns

Array containing the values for the column gaps, or None if the array is empty or the attribute is not defined.

pub fn column_widths(&self) -> Vec<f64>

Obtains an array with the widths of the columns.

The array with the results is allocated by the function. When it is not needed anymore, be sure to call g_free() on it.

Returns

Array containing widths of the columns, or None if the attribute is not defined.

pub fn end_indent(&self) -> f64

Obtains the amount of indentation at the end of the block-level structure element.

Returns

A numeric value.

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

Obtains the textual description of the form element. Note that the description is for informative purposes, and it is not intended to be rendered. For example, assistive technologies may use the description field to provide an alternate way of presenting an element to the user.

The returned string is allocated by the function. When it is not needed anymore, be sure to call g_free() on it.

Returns

A string, or None if the attribute is not defined.

pub fn form_role(&self) -> StructureFormRole

Obtains the role of a form structure element that is part of a form, or is a form field. This hints how the control for the element is intended to be rendered.

Returns

A StructureFormRole value.

pub fn form_state(&self) -> StructureFormState

For a structure element that is a form field, obtains in which state the associated control is expected to be rendered.

Returns

A StructureFormState value.

pub fn glyph_orientation(&self) -> StructureGlyphOrientation

Obtains the glyph orientation for the text contained in a inline-level structure element.

Returns

A StructureGlyphOrientation value.

pub fn height(&self) -> f64

Obtains the height of the block-level structure element. Note that for elements which do not specify a height, it has to be calculated, and in this case -1 is returned.

Returns

A positive value if a width is defined, or -1 if the height is to be calculated automatically.

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

Obtains the identifier of an element.

Returns

The identifier of the element (if defined), or None.

pub fn inline_align(&self) -> StructureInlineAlign

Obtains the inline-alignment mode of the block-level structure element.

Returns

A StructureInlineAlign value.

pub fn kind(&self) -> StructureElementKind

Returns

A StructureElementKind value.

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

Obtains the language and country code for the content in an element, in two-letter ISO format, e.g. <code>en_ES</code>, or None if not defined.

Returns

language and country code, or None.

pub fn line_height(&self) -> f64

Obtains the line height for the text contained in the inline-level structure element. Note that for elements which do not specify a line height, it has to be calculated, and in this case -1 is returned.

Returns

A positive value if a line height is defined, or -1 if the height is to be calculated automatically.

pub fn list_numbering(&self) -> StructureListNumbering

Obtains the list numbering style for list items.

Returns

A StructureListNumbering value.

pub fn page(&self) -> i32

Obtains the page number in which the element is contained.

Returns

Number of the page that contains the element, of <code>-1</code> if not defined.

pub fn placement(&self) -> StructurePlacement

Obtains the placement type of the structure element.

Returns

A StructurePlacement value.

pub fn ruby_align(&self) -> StructureRubyAlign

Obtains the alignment for the ruby text contained in a inline-level structure element.

Returns

A StructureRubyAlign value.

pub fn ruby_position(&self) -> StructureRubyPosition

Obtains the position for the ruby text contained in a inline-level structure element.

Returns

A StructureRubyPosition value.

pub fn space_after(&self) -> f64

Obtains the amount of empty space after the block-level structure element.

Returns

A positive value.

pub fn space_before(&self) -> f64

Obtains the amount of empty space before the block-level structure element.

Returns

A positive value.

pub fn start_indent(&self) -> f64

Obtains the amount of indentation at the beginning of the block-level structure element.

Returns

A numeric value.

pub fn table_column_span(&self) -> u32

Obtains the number of columns the table element spans to.

Returns

A positive, non-zero value.

pub fn table_headers(&self) -> Vec<GString>

Obtains an array with the names of the table column headers. This is only useful for table header row elements.

The array with the results is allocated by the function. The number of items in the returned array can be obtained with g_strv_length(). The returned value must be freed using g_strfreev().

Returns

Zero-terminated array of strings with the table header names, or None if the attribute is not defined.

pub fn table_row_span(&self) -> u32

Obtains the number of rows the table element spans to.

Returns

A positive, non-zero value.

pub fn table_scope(&self) -> StructureTableScope

Obtains the scope of a table structure element.

Returns

A StructureTableScope value.

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

Obtains the textual summary of the contents of the table element. Note that the summary is meant for informative purposes, and it is not intended to be rendered. For example, assistive technologies may use the description field to provide an alternate way of presenting an element to the user, or a document indexer may want to scan it for additional keywords.

The returned string is allocated by the function. When it is not needed anymore, be sure to call g_free() on it.

Returns

A string, or None if the attribute is not defined.

pub fn text(&self, flags: StructureGetTextFlags) -> Option<GString>

Obtains the text enclosed by an element, or the text enclosed by the elements in the subtree (including the element itself).

flags

A StructureGetTextFlags value, or StructureGetTextFlags::NONE to disable all the flags.

Returns

A string.

pub fn text_align(&self) -> StructureTextAlign

Obtains the text alignment mode of the text contained into a block-level structure element.

Returns

A StructureTextAlign value.

pub fn text_decoration_color(&self) -> Option<Color>

Obtains the color of the text decoration for the text contained in the inline-level structure element. If this attribute is not specified, the color for this element shall be the current fill color in effect at the start of its associated content.

Returns

true if a color is defined for the element, false otherwise.

color

A Color.

pub fn text_decoration_thickness(&self) -> f64

Obtains the thickness of the text decoration for the text contained in the inline-level structure element. If this attribute is not specified, it shall be derived from the current stroke thickness in effect at the start of the element’s associated content.

Returns

Thickness of the text decoration, or NAN if not defined.

pub fn text_decoration_type(&self) -> StructureTextDecoration

Obtains the text decoration type of the text contained in the inline-level structure element.

Returns

A StructureTextDecoration value.

pub fn text_indent(&self) -> f64

Obtains the amount of indentation of the text contained in the block-level structure element.

Returns

A numeric value.

pub fn text_spans(&self) -> Vec<TextSpan>

Obtains the text enclosed by an element, as an array of TextSpan structures. Each item in the list is a piece of text which share the same attributes, plus its attributes. The following example shows how to obtain and free the text spans of an element:

<informalexample>``<programlisting> guint i, n_spans; PopplerTextSpan *text_spans = poppler_structure_element_get_text_spans (element, &n_spans); / Use the text spans */ for (i = 0; i < n_spans; i++) poppler_text_span_free (text_spans[i]); g_free (text_spans); </programlisting>``</informalexample>

Returns

An array of TextSpan elements.

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

Obtains the title of an element.

Returns

The title of the element, or None.

pub fn width(&self) -> f64

Obtains the width of the block-level structure element. Note that for elements which do not specify a width, it has to be calculated, and in this case -1 is returned.

Returns

A positive value if a width is defined, or -1 if the width is to be calculated automatically.

pub fn writing_mode(&self) -> StructureWritingMode

Obtains the writing mode (writing direction) of the content associated with a structure element.

Returns

A StructureWritingMode value.

pub fn is_block(&self) -> bool

Checks whether an element is a block element.

Returns

true if the element is a block element, or false otherwise.

pub fn is_content(&self) -> bool

Checks whether an element is actual document content.

Returns

true if the element is content, or false otherwise.

pub fn is_grouping(&self) -> bool

Checks whether an element is a grouping element.

Returns

true if the element is a grouping element, false otherwise.

pub fn is_inline(&self) -> bool

Checks whether an element is an inline element.

Returns

true if the element is an inline element, or false otherwise.

Trait Implementations

impl Clone for StructureElement

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructureElement

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

Formats the value using the given formatter.

impl Display for StructureElement

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

Formats the value using the given formatter.

impl HasParamSpec for StructureElement

type ParamSpec = ParamSpecObject

type SetValue = StructureElement

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for StructureElement

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

Feeds this value into the given Hasher.

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 StructureElement

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for StructureElement

type Parent = Object

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

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

This method tests for self and other values to be equal, and is used by ==.

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 StructureElement

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

This method returns an ordering between self and other values if one exists.

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 StructureElement

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StructureElement