Poppler.StructureElement – poppler-glib Reference Manual
Packages
poppler-glib
Poppler
StructureElement
StructureElement
get_abbreviation
get_actual_text
get_alt_text
get_background_color
get_baseline_shift
get_block_align
get_border_color
get_border_style
get_border_thickness
get_bounding_box
get_color
get_column_count
get_column_gaps
get_column_widths
get_end_indent
get_form_description
get_form_role
get_form_state
get_glyph_orientation
get_height
get_id
get_inline_align
get_kind
get_language
get_line_height
get_list_numbering
get_padding
get_page
get_placement
get_ruby_align
get_ruby_position
get_space_after
get_space_before
get_start_indent
get_table_border_style
get_table_column_span
get_table_headers
get_table_padding
get_table_row_span
get_table_scope
get_table_summary
get_text
get_text_align
get_text_decoration_color
get_text_decoration_thickness
get_text_decoration_type
get_text_indent
get_text_spans
get_title
get_width
get_writing_mode
is_block
is_content
is_grouping
is_inline
StructureElement
Object Hierarchy:
Description:
[
CCode
( type_id =
"poppler_structure_element_get_type ()"
) ]
public
class
StructureElement
:
Object
A
Document
structure element.
Since 25.06 this type supports g_autoptr
Namespace:
Poppler
Package:
poppler-glib
Content:
Creation methods:
protected
StructureElement
()
Methods:
public
string
get_abbreviation
()
Acronyms and abbreviations contained in elements of type
SPAN
may have an associated expanded text form, which can be retrieved using this function.
public
string
get_actual_text
()
Obtains the actual text enclosed by the element (and its child elements).
public
string
get_alt_text
()
Obtains the “alternate” text representation of the element (and its child elements).
public
bool
get_background_color
(
out
unowned
Color
color)
Obtains the background color of the element.
public
double
get_baseline_shift
()
Obtains how much the text contained in the inline-level structure element should be shifted, measuring from the baseline of the glyphs.
public
StructureBlockAlign
get_block_align
()
Obtains the block-alignment mode of the block-level structure element.
public
bool
get_border_color
(
out
unowned
(
unowned
Color
)[] colors)
Obtains the color of border around the element.
public
void
get_border_style
(
out
StructureBorderStyle
[] border_styles)
Obtains the border style of a structure element.
public
bool
get_border_thickness
(
out
double
[] border_thicknesses)
Obtains the thickness of the border of an element.
public
bool
get_bounding_box
(
out
Rectangle
bounding_box)
Obtains the size of the bounding box of a block-level structure element.
public
bool
get_color
(
out
unowned
Color
color)
Obtains the color of the content contained in the element.
public
uint
get_column_count
()
Obtains the number of columns used to lay out the content contained in the grouping element.
public
double
[]
get_column_gaps
()
Obtains the size of the gaps in between adjacent columns.
public
double
[]
get_column_widths
()
Obtains an array with the widths of the columns.
public
double
get_end_indent
()
Obtains the amount of indentation at the end of the block-level structure element.
public
string
get_form_description
()
Obtains the textual description of the form element.
public
StructureFormRole
get_form_role
()
Obtains the role of a form structure element that is part of a form, or is a form field.
public
StructureFormState
get_form_state
()
For a structure element that is a form field, obtains in which state the associated control is expected to be rendered.
public
StructureGlyphOrientation
get_glyph_orientation
()
Obtains the glyph orientation for the text contained in a inline-level structure element.
public
double
get_height
()
Obtains the height of the block-level structure element.
public
string
get_id
()
Obtains the identifier of an element.
public
StructureInlineAlign
get_inline_align
()
Obtains the inline-alignment mode of the block-level structure element.
public
StructureElementKind
get_kind
()
public
string
get_language
()
Obtains the language and country code for the content in an element, in two-letter ISO format, e.
public
double
get_line_height
()
Obtains the line height for the text contained in the inline-level structure element.
public
StructureListNumbering
get_list_numbering
()
Obtains the list numbering style for list items.
public
void
get_padding
(
out
double
[] paddings)
Obtains the padding of an element (space around it).
public
int
get_page
()
Obtains the page number in which the element is contained.
public
StructurePlacement
get_placement
()
Obtains the placement type of the structure element.
public
StructureRubyAlign
get_ruby_align
()
Obtains the alignment for the ruby text contained in a inline-level structure element.
public
StructureRubyPosition
get_ruby_position
()
Obtains the position for the ruby text contained in a inline-level structure element.
public
double
get_space_after
()
Obtains the amount of empty space after the block-level structure element.
public
double
get_space_before
()
Obtains the amount of empty space before the block-level structure element.
public
double
get_start_indent
()
Obtains the amount of indentation at the beginning of the block-level structure element.
public
void
get_table_border_style
(
out
StructureBorderStyle
[] border_styles)
Obtains the table cell border style of a block-level structure element.
public
uint
get_table_column_span
()
Obtains the number of columns the table element spans to.
public
string
[]
get_table_headers
()
Obtains an array with the names of the table column headers.
public
void
get_table_padding
(
out
double
[] paddings)
Obtains the padding between the table cell’s content rectangle and the surrounding border of a block-level structure element.
public
uint
get_table_row_span
()
Obtains the number of rows the table element spans to.
public
StructureTableScope
get_table_scope
()
Obtains the scope of a table structure element.
public
string
get_table_summary
()
Obtains the textual summary of the contents of the table element.
public
string
get_text
(
StructureGetTextFlags
flags)
Obtains the text enclosed by an element, or the text enclosed by the elements in the subtree (including the element itself).
public
StructureTextAlign
get_text_align
()
Obtains the text alignment mode of the text contained into a block-level structure element.
public
bool
get_text_decoration_color
(
out
unowned
Color
color)
Obtains the color of the text decoration for the text contained in the inline-level structure element.
public
double
get_text_decoration_thickness
()
Obtains the thickness of the text decoration for the text contained in the inline-level structure element.
public
StructureTextDecoration
get_text_decoration_type
()
Obtains the text decoration type of the text contained in the inline-level structure element.
public
double
get_text_indent
()
Obtains the amount of indentation of the text contained in the block-level structure element.
public
TextSpan
[]
get_text_spans
()
Obtains the text enclosed by an element, as an array of
TextSpan
structures.
public
string
get_title
()
Obtains the title of an element.
public
double
get_width
()
Obtains the width of the block-level structure element.
public
StructureWritingMode
get_writing_mode
()
Obtains the writing mode (writing direction) of the content associated with a structure element.
public
bool
is_block
()
Checks whether an element is a block element.
public
bool
is_content
()
Checks whether an element is actual document content.
public
bool
is_grouping
()
Checks whether an element is a grouping element.
public
bool
is_inline
()
Checks whether an element is an inline element.
Inherited Members:
All known members inherited from class GLib.Object
@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data
get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer
replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref