Scribus API for plugins
A stable, high level and documented interface to the Scribus core that plugin developers can use to access the Scribus features.
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ScribusAPIDocumentItem Class Reference
Inheritance diagram for ScribusAPIDocumentItem:
Inheritance graph
[legend]
Collaboration diagram for ScribusAPIDocumentItem:
Collaboration graph
[legend]

Public Member Functions

 ScribusAPIDocumentItem (PageItem *item)
 
PageItem * getItem ()
 
void setPageNumber (int pageNumber)
 
bool isBefore (ScribusAPIDocumentItem *const item) const
 
int getX () const
 
int getY () const
 
void render ()
 
bool isTextFrame ()
 
bool isImageFrame ()
 
ScribusAPIDocumentItemTextgetText ()
 
QString getName ()
 
ScribusAPIDocumentItemImageWeb getImageWeb ()
 
QList< ScribusAPIDocumentItemResourceFilegetResourceFiles ()
 

Static Public Member Functions

static bool isBeforeQSort (ScribusAPIDocumentItem *const item1, ScribusAPIDocumentItem *const item2)
 

Protected Attributes

int pageNumber
 
PageItem * scribusItem
 

Member Function Documentation

◆ getImageWeb()

ScribusAPIDocumentItemImageWeb ScribusAPIDocumentItem::getImageWeb ( )
Returns
the visible part of the image in PNG or JPG format

◆ isBefore()

bool ScribusAPIDocumentItem::isBefore ( ScribusAPIDocumentItem *const  item) const

TODO:

  • as soon as other write directions are to be considered the order has to be made more flexible
  • we could have fancier rules for the position

◆ isBeforeQSort()

static bool ScribusAPIDocumentItem::isBeforeQSort ( ScribusAPIDocumentItem *const  item1,
ScribusAPIDocumentItem *const  item2 
)
inlinestatic

used by qSort to sort the items by their place on the page


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