Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- getAbbreviation
- getActualText
- getAltText
- getBackgroundColor
- getBaselineShift
- getBlockAlign
- getBorderStyle
- getBorderThickness
- getBoundingBox
- getColor
- getColumnCount
- getColumnGaps
- getColumnWidths
- getEndIndent
- getFormDescription
- getFormRole
- getFormState
- getGlyphOrientation
- getHeight
- getId
- getInlineAlign
- getKind
- getLanguage
- getLineHeight
- getListNumbering
- getPadding
- getPage
- getPlacement
- getRubyAlign
- getRubyPosition
- getSpaceAfter
- getSpaceBefore
- getStartIndent
- getTableBorderStyle
- getTableColumnSpan
- getTableHeaders
- getTablePadding
- getTableRowSpan
- getTableScope
- getTableSummary
- getText
- getTextAlign
- getTextDecorationColor
- getTextDecorationThickness
- getTextDecorationType
- getTextIndent
- getTextSpans
- getTitle
- getWidth
- getWritingMode
- isBlock
- isContent
- isGrouping
- isInline
No description available in the introspection data.
Synopsis
- newtype StructureElement = StructureElement (ManagedPtr StructureElement)
- class (GObject o, IsDescendantOf StructureElement o) => IsStructureElement o
- toStructureElement :: (MonadIO m, IsStructureElement o) => o -> m StructureElement
- noStructureElement :: Maybe StructureElement
- structureElementGetAbbreviation :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetActualText :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetAltText :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetBackgroundColor :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m (Bool, Color)
- structureElementGetBaselineShift :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetBlockAlign :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureBlockAlign
- structureElementGetBorderStyle :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [StructureBorderStyle]
- structureElementGetBorderThickness :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m (Bool, [Double])
- structureElementGetBoundingBox :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m (Bool, Rectangle)
- structureElementGetColor :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m (Bool, Color)
- structureElementGetColumnCount :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Word32
- structureElementGetColumnGaps :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [Double]
- structureElementGetColumnWidths :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [Double]
- structureElementGetEndIndent :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetFormDescription :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetFormRole :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureFormRole
- structureElementGetFormState :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureFormState
- structureElementGetGlyphOrientation :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureGlyphOrientation
- structureElementGetHeight :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetId :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetInlineAlign :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureInlineAlign
- structureElementGetKind :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureElementKind
- structureElementGetLanguage :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetLineHeight :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetListNumbering :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureListNumbering
- structureElementGetPadding :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [Double]
- structureElementGetPage :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Int32
- structureElementGetPlacement :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructurePlacement
- structureElementGetRubyAlign :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureRubyAlign
- structureElementGetRubyPosition :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureRubyPosition
- structureElementGetSpaceAfter :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetSpaceBefore :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetStartIndent :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetTableBorderStyle :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [StructureBorderStyle]
- structureElementGetTableColumnSpan :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Word32
- structureElementGetTableHeaders :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [Text]
- structureElementGetTablePadding :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [Double]
- structureElementGetTableRowSpan :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Word32
- structureElementGetTableScope :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureTableScope
- structureElementGetTableSummary :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetText :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> [StructureGetTextFlags] -> m Text
- structureElementGetTextAlign :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureTextAlign
- structureElementGetTextDecorationColor :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m (Bool, Color)
- structureElementGetTextDecorationThickness :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetTextDecorationType :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureTextDecoration
- structureElementGetTextIndent :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetTextSpans :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m [TextSpan]
- structureElementGetTitle :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Text
- structureElementGetWidth :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Double
- structureElementGetWritingMode :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m StructureWritingMode
- structureElementIsBlock :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Bool
- structureElementIsContent :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Bool
- structureElementIsGrouping :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Bool
- structureElementIsInline :: (HasCallStack, MonadIO m, IsStructureElement a) => a -> m Bool
Exported types
newtype StructureElement Source #
Memory-managed wrapper type.
Instances
GObject StructureElement Source # | |
Defined in GI.Poppler.Objects.StructureElement gobjectType :: IO GType # | |
HasParentTypes StructureElement Source # | |
Defined in GI.Poppler.Objects.StructureElement | |
type ParentTypes StructureElement Source # | |
Defined in GI.Poppler.Objects.StructureElement |
class (GObject o, IsDescendantOf StructureElement o) => IsStructureElement o Source #
Type class for types which can be safely cast to StructureElement
, for instance with toStructureElement
.
Instances
(GObject o, IsDescendantOf StructureElement o) => IsStructureElement o Source # | |
Defined in GI.Poppler.Objects.StructureElement |
toStructureElement :: (MonadIO m, IsStructureElement o) => o -> m StructureElement Source #
Cast to StructureElement
, for types for which this is known to be safe. For general casts, use castTo
.
noStructureElement :: Maybe StructureElement Source #
A convenience alias for Nothing
:: Maybe
StructureElement
.
Methods
getAbbreviation
structureElementGetAbbreviation Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: Text of the expanded abbreviation if the
element text is an abbreviation or acrony, |
Acronyms and abbreviations contained in elements of type
POPPLER_STRUCTURE_ELEMENT_SPAN
may have an associated expanded
text form, which can be retrieved using this function.
Since: 0.26
getActualText
structureElementGetActualText Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: The actual text for the element, or |
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
structureElementGetText
must be used instead.
Since: 0.26
getAltText
structureElementGetAltText Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: The alternate text representation for the
element, or |
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
structureElementGetText
must be used instead.
Since: 0.26
getBackgroundColor
structureElementGetBackgroundColor Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m (Bool, Color) | Returns: |
Obtains the background color of the element. If this attribute is not specified, the element shall be treated as if it were transparent.
Since: 0.26
getBaselineShift
structureElementGetBaselineShift Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A numeric value. |
Obtains how much the text contained in the inline-level structure element should be shifted, measuring from the baseline of the glyphs.
Since: 0.26
getBlockAlign
structureElementGetBlockAlign Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureBlockAlign | Returns: A |
Obtains the block-alignment mode of the block-level structure element.
Since: 0.26
getBorderStyle
structureElementGetBorderStyle Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [StructureBorderStyle] |
Obtains the border style of a structure element. The result values are in before-after-start-end ordering. For example, using Western left-to-right writing, that is top-bottom-left-right.
Since: 0.26
getBorderThickness
structureElementGetBorderThickness Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m (Bool, [Double]) | Returns: |
Obtains the thickness of the border of an element. The result values are in before-after-start-end ordering (for the typical Western left-to-right writing, that is top-bottom-left-right). A value of 0 indicates that the border shall not be drawn.
Since: 0.26
getBoundingBox
structureElementGetBoundingBox Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m (Bool, Rectangle) | Returns: |
Obtains the size of the bounding box of a block-level structure element.
Since: 0.26
getColor
structureElementGetColor Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m (Bool, Color) | Returns: |
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.
Since: 0.26
getColumnCount
structureElementGetColumnCount Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Word32 | Returns: Number of columns. |
Obtains the number of columns used to lay out the content contained in the grouping element.
Since: 0.26
getColumnGaps
structureElementGetColumnGaps Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [Double] | Returns:
Array containing the values for the column gaps, or |
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, Nothing
is returned and nValues
is set to zero.
If the attribute is undefined, Nothing
is returned and nValues
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 free
on it.
Since: 0.26
getColumnWidths
structureElementGetColumnWidths Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [Double] | Returns:
Array containing widths of the columns, or |
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 free
on it.
Since: 0.26
getEndIndent
structureElementGetEndIndent Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A numeric value. |
Obtains the amount of indentation at the end of the block-level structure element.
Since: 0.26
getFormDescription
structureElementGetFormDescription Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: A string, or |
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 free
on it.
Since: 0.26
getFormRole
structureElementGetFormRole Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureFormRole | Returns: A |
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.
Since: 0.26
getFormState
structureElementGetFormState Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureFormState | Returns: A |
For a structure element that is a form field, obtains in which state the associated control is expected to be rendered.
Since: 0.26
getGlyphOrientation
structureElementGetGlyphOrientation Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureGlyphOrientation | Returns: A |
Obtains the glyph orientation for the text contained in a inline-level structure element.
Since: 0.26
getHeight
structureElementGetHeight Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A positive value if a width is defined, or -1 if the height is to be calculated automatically. |
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.
Since: 0.26
getId
structureElementGetId Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: The identifier of the element (if
defined), or |
Obtains the identifier of an element.
Since: 0.26
getInlineAlign
structureElementGetInlineAlign Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureInlineAlign | Returns: A |
Obtains the inline-alignment mode of the block-level structure element.
Since: 0.26
getKind
structureElementGetKind Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureElementKind | Returns: A |
No description available in the introspection data.
Since: 0.26
getLanguage
structureElementGetLanguage Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: language and country code, or |
Obtains the language and country code for the content in an element,
in two-letter ISO format, e.g. <code>en_ES</code>, or Nothing
if not
defined.
Since: 0.26
getLineHeight
structureElementGetLineHeight Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A positive value if a line height is defined, or -1 if the height is to be calculated automatically. |
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.
Since: 0.26
getListNumbering
structureElementGetListNumbering Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureListNumbering | Returns: A |
Obtains the list numbering style for list items.
Since: 0.26
getPadding
structureElementGetPadding Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [Double] |
Obtains the padding of an element (space around it). The result values are in before-after-start-end ordering. For example using Western left-to-right writing, that is top-bottom-left-right.
Since: 0.26
getPage
structureElementGetPage Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Int32 | Returns: Number of the page that contains the element, of <code>-1</code> if not defined. |
Obtains the page number in which the element is contained.
Since: 0.26
getPlacement
structureElementGetPlacement Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructurePlacement | Returns: A |
Obtains the placement type of the structure element.
Since: 0.26
getRubyAlign
structureElementGetRubyAlign Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureRubyAlign | Returns: A |
Obtains the alignment for the ruby text contained in a inline-level structure element.
Since: 0.26
getRubyPosition
structureElementGetRubyPosition Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureRubyPosition | Returns: A |
Obtains the position for the ruby text contained in a inline-level structure element.
Since: 0.26
getSpaceAfter
structureElementGetSpaceAfter Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A positive value. |
Obtains the amount of empty space after the block-level structure element.
Since: 0.26
getSpaceBefore
structureElementGetSpaceBefore Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A positive value. |
Obtains the amount of empty space before the block-level structure element.
Since: 0.26
getStartIndent
structureElementGetStartIndent Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A numeric value. |
Obtains the amount of indentation at the beginning of the block-level structure element.
Since: 0.26
getTableBorderStyle
structureElementGetTableBorderStyle Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [StructureBorderStyle] |
Obtains the table cell border style of a block-level structure element. The result values are in before-after-start-end ordering. For example, using Western left-to-right writing, that is top-bottom-left-right.
Since: 0.26
getTableColumnSpan
structureElementGetTableColumnSpan Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Word32 | Returns: A positive, non-zero value. |
Obtains the number of columns the table element spans to.
Since: 0.26
getTableHeaders
structureElementGetTableHeaders Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [Text] | Returns:
Zero-terminated array of strings with the table header names,
or |
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 strvLength
.
The returned value must be freed using strfreev
.
Since: 0.26
getTablePadding
structureElementGetTablePadding Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [Double] |
Obtains the padding between the table cell’s content rectangle and the surrounding border of a block-level structure element. The result values are in before-after-start-end ordering (for the typical Western left-to-right writing, that is top-bottom-left-right).
Since: 0.26
getTableRowSpan
structureElementGetTableRowSpan Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Word32 | Returns: A positive, non-zero value. |
Obtains the number of rows the table element spans to.
Since: 0.26
getTableScope
structureElementGetTableScope Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureTableScope | Returns: A |
Obtains the scope of a table structure element.
Since: 0.26
getTableSummary
structureElementGetTableSummary Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: A string, or |
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 free
on it.
Since: 0.26
getText
structureElementGetText Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> [StructureGetTextFlags] |
|
-> m Text | Returns: A string. |
Obtains the text enclosed by an element, or the text enclosed by the elements in the subtree (including the element itself).
Since: 0.26
getTextAlign
structureElementGetTextAlign Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureTextAlign | Returns: A |
Obtains the text alignment mode of the text contained into a block-level structure element.
Since: 0.26
getTextDecorationColor
structureElementGetTextDecorationColor Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m (Bool, Color) | Returns: |
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.
Since: 0.26
getTextDecorationThickness
structureElementGetTextDecorationThickness Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: Thickness of the text decoration, or NAN if not defined. |
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.
Since: 0.26
getTextDecorationType
structureElementGetTextDecorationType Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureTextDecoration | Returns: A |
Obtains the text decoration type of the text contained in the inline-level structure element.
Since: 0.26
getTextIndent
structureElementGetTextIndent Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A numeric value. |
Obtains the amount of indentation of the text contained in the block-level structure element.
Since: 0.26
getTextSpans
structureElementGetTextSpans Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m [TextSpan] | Returns:
An array of |
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>
Since: 0.26
getTitle
structureElementGetTitle Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Text | Returns: The title of the element, or |
Obtains the title of an element.
Since: 0.26
getWidth
structureElementGetWidth Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Double | Returns: A positive value if a width is defined, or -1 if the width is to be calculated automatically. |
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.
Since: 0.26
getWritingMode
structureElementGetWritingMode Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m StructureWritingMode | Returns: A |
Obtains the writing mode (writing direction) of the content associated with a structure element.
Since: 0.26
isBlock
structureElementIsBlock Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether an element is a block element.
Since: 0.26
isContent
structureElementIsContent Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether an element is actual document content.
Since: 0.26
isGrouping
structureElementIsGrouping Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether an element is a grouping element.
Since: 0.26
isInline
structureElementIsInline Source #
:: (HasCallStack, MonadIO m, IsStructureElement a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether an element is an inline element.
Since: 0.26