PDFix SDK  6.5.0
PdeImage Struct Referenceabstract

PdeImage class. More...

Inheritance diagram for PdeImage:
PdeContainer PdeElement

Public Member Functions

virtual PdfImageType GetImageType ()=0
 Gets the type of an image. More...
 
virtual PdeElementGetCaption ()=0
 Gets the caption of the image. Iterate it's children if the element is PdeContainer. More...
 
- Public Member Functions inherited from PdeElement
virtual PdfElementType GetType ()=0
 Gets the type of an element. More...
 
virtual void GetBBox (PdfRect *bbox)=0
 
virtual bool SetBBox (const PdfRect *bbox)=0
 
virtual int GetId ()=0
 Gets the id of an element. The id is unique number on a page. More...
 
virtual void GetGraphicState (PdfGraphicState *g_state)=0
 Gets the graphics state information for an element. More...
 
virtual int GetNumChildren ()=0
 Gets the number of child elements in an element object. More...
 
virtual PdeElementGetChild (int index)=0
 Gets the requested child element from an element. More...
 
virtual PdfAlignment GetAlignment ()=0
 Gets the element alignment within the content column. More...
 
virtual double GetAngle ()=0
 Gets the element angle. More...
 
virtual void SetRender (bool render)=0
 Sets render mode of the element. This mode is used, when element is saved. More...
 
virtual void SetData (void *data)=0
 Sets user-supplied data to pass to the element. More...
 
virtual void * GetData ()=0
 Gets user-supplied data to pass to the element. More...
 
virtual bool SetAlt (const wchar_t *alt)=0
 Sets the alternate description of the element. More...
 
virtual bool SetActualText (const wchar_t *text)=0
 Sets the actual text of the element. More...
 
virtual int GetFlags ()=0
 Get the element state flags. More...
 
virtual bool SetFlags (int flags)=0
 Set the element state flags. More...
 
virtual int GetNumPageObjects ()=0
 Get the the number pf page object in the element. More...
 
virtual PdsPageObjectGetPageObject (int index)=0
 Get the the page object of the element by index. More...
 
virtual PdePageMapGetPageMap ()=0
 Get the the page map object containing this element. More...
 

Detailed Description

PdeImage class.

A PdeImage class is a page content element containing an image graphics.

Member Function Documentation

◆ GetCaption()

virtual PdeElement* PdeImage::GetCaption ( )
pure virtual

Gets the caption of the image. Iterate it's children if the element is PdeContainer.

Returns
The caption element.

◆ GetImageType()

virtual PdfImageType PdeImage::GetImageType ( )
pure virtual

Gets the type of an image.

Returns
PdfImageType type.