All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::Layout::Float Class Reference

#include <ContentTree.h>

+ Inheritance diagram for pdftron::Layout::Float:

Public Types

enum  FloatReferencePoint { e_reference_page = 1, e_reference_paragraph = 2, e_reference_character = 3 }
 
enum  FloatObstructionType {
  e_behind_text = 1, e_in_front_of_text = 2, e_square = 3, e_tight = 4,
  e_top_and_bottom = 5
}
 

Public Member Functions

 ~Float ()
 
void Destroy ()
 
void SetHorizontalReferencePoint (FloatReferencePoint point)
 
FloatReferencePoint GetHorizontalReferencePoint ()
 
void SetVerticalReferencePoint (FloatReferencePoint point)
 
FloatReferencePoint GetVerticalReferencePoint ()
 
void SetPositionX (double x)
 
double GetPositionX ()
 
void SetPositionY (double y)
 
double GetPositionY ()
 
void SetObstructionType (FloatObstructionType type)
 
FloatObstructionType GetObstructionType ()
 
- Public Member Functions inherited from pdftron::Layout::ContentContainer
Paragraph AddParagraph ()
 
Paragraph AddParagraph (const UString &text)
 
List AddList ()
 
Table AddTable ()
 
- Public Member Functions inherited from pdftron::Layout::ContentNode
 ~ContentNode ()
 
void Destroy ()
 
ContentNodeIterator GetContentNodeIterator ()
 
- Public Member Functions inherited from pdftron::Layout::ContentElement
 ~ContentElement ()
 
void Destroy ()
 
ElementRef< List > AsList () const
 
ElementRef< ListItem > AsListItem () const
 
ElementRef< ContentNode > AsContentNode () const
 
ElementRef< TextRun > AsTextRun () const
 
ElementRef< PageNumber > AsPageNumber () const
 
ElementRef< Shape > AsShape () const
 
ElementRef< Float > AsFloat () const
 
ElementRef< Chart > AsChart () const
 
ElementRef< Paragraph > AsParagraph () const
 
ElementRef< Table > AsTable () const
 
ElementRef< TableRow > AsTableRow () const
 
ElementRef< TableCell > AsTableCell () const
 
TextStyledElement GetTextStyledElement ()
 

Friends

class Paragraph
 
class ElementRef< Float >
 

Additional Inherited Members

- Public Attributes inherited from pdftron::Layout::ContentElement
TRN_ContentElement m_impl
 
- Protected Member Functions inherited from pdftron::Layout::ContentContainer
 ContentContainer (TRN_ContentContainer impl)
 
- Protected Member Functions inherited from pdftron::Layout::ContentNode
 ContentNode (TRN_ContentNode impl)
 
- Protected Member Functions inherited from pdftron::Layout::ContentElement
 ContentElement (TRN_ContentElement impl)
 

Detailed Description

A Float is a content container that is positioned outside of the main document flow, relative to a chosen reference point, with the main document content wrapped around it.

Definition at line 652 of file ContentTree.h.

Member Enumeration Documentation

Defines the way the content of the float interacts with the main document content.

Enumerator
e_behind_text 
e_in_front_of_text 
e_square 
e_tight 
e_top_and_bottom 

Definition at line 677 of file ContentTree.h.

Defines the available reference points for a float.

Enumerator
e_reference_page 
e_reference_paragraph 
e_reference_character 

Definition at line 666 of file ContentTree.h.

Constructor & Destructor Documentation

pdftron::Layout::Float::~Float ( )

Member Function Documentation

void pdftron::Layout::Float::Destroy ( )
FloatReferencePoint pdftron::Layout::Float::GetHorizontalReferencePoint ( )

Get the horizontal reference point of the float.

Returns
The horizontal reference point.
FloatObstructionType pdftron::Layout::Float::GetObstructionType ( )

Get the way the content of the float interacts with the main document content.

Returns
The obstruction type.
double pdftron::Layout::Float::GetPositionX ( )

Get the horizontal position of the float in points.

Returns
The horizontal position in points.
double pdftron::Layout::Float::GetPositionY ( )

Get the vertical position of the float in points.

Returns
The vertical position in points.
FloatReferencePoint pdftron::Layout::Float::GetVerticalReferencePoint ( )

Get the vertical reference point of the float.

Returns
The vertical reference point.
void pdftron::Layout::Float::SetHorizontalReferencePoint ( FloatReferencePoint  point)

Set the horizontal reference point of the float.

Parameters
pointThe horizontal reference point.
void pdftron::Layout::Float::SetObstructionType ( FloatObstructionType  type)

Set the way the content of the float interacts with the main document content.

Parameters
typeThe obstruction type.
void pdftron::Layout::Float::SetPositionX ( double  x)

Set the horizontal position of the float, in points, relative to the horizontal reference point.

Parameters
xThe horizontal position in points.
void pdftron::Layout::Float::SetPositionY ( double  y)

Set the vertical position of the float, in points, relative to the vertical reference point.

Parameters
yThe vertical position in points.
void pdftron::Layout::Float::SetVerticalReferencePoint ( FloatReferencePoint  point)

Set the vertical reference point of the float.

Parameters
pointThe vertical reference point.

Friends And Related Function Documentation

friend class ElementRef< Float >
friend

Definition at line 655 of file ContentTree.h.

friend class Paragraph
friend

Definition at line 654 of file ContentTree.h.


The documentation for this class was generated from the following file: