kpresenter

KPrPage Class Reference

List of all members.

Detailed Description

Definition at line 59 of file KPrPage.h.


Public Member Functions

 KPrPage (KPrDocument *_doc, KPrPage *masterPage=0)
virtual ~KPrPage ()
virtual DCOPObject * dcopObject ()
KPrDocumentkPresenterDoc () const
QString manualTitle () const
void insertManualTitle (const QString &title)
QString pageTitle (const QString &_title=QString()) const
void setNoteText (const QString &_text)
QString noteText () const
void setMasterPage (KPrPage *_masterPage)
KPrPagemasterPage () const
bool isMasterPage () const
const QPtrList< KPrObject > & objectList () const
KPrObjectgetObject (int num)
void appendObject (KPrObject *_obj)
void appendObjects (const QValueList< KPrObject * > &objects)
void replaceObject (KPrObject *oldObject, KPrObject *newObject)
int takeObject (KPrObject *object)
KCommand * deleteSelectedObjects ()
void insertObject (KPrObject *object, int pos)
void completeLoading (bool _clean, int lastObj)
void unifyObjectName (KPrObject *object)
KoRect getPageRect () const
QRect getZoomPageRect () const
void setObjectList (QPtrList< KPrObject > objectLlist)
unsigned int objNums () const
int numTextObject () const
KPrTextObjecttextFrameSet (unsigned int _num) const
int numSelected () const
void pasteObjs (const QByteArray &data, int nbCopy=1, double angle=0.0, double _increaseX=0.0, double increaseY=0.0, double moveX=0.0, double moveY=0.0)
KCommand * replaceObjs (bool createUndoRedo, double _orastX, double _orastY, const QColor &_txtBackCol, const QColor &_otxtBackCol)
void copyObjs (QDomDocument &doc, QDomElement &presenter, QValueList< KoPictureKey > &lst) const
KPrObjectgetSelectedObj () const
QPtrList< KPrObjectgetSelectedObjects (bool withoutHeaderFooter=false) const
KPrPixmapObjectgetSelectedImage () const
KCommand * setImageEffect (ImageEffect eff, QVariant param1, QVariant param2, QVariant param3)
void groupObjects ()
void ungroupObjects (KMacroCommand **macro)
void raiseObjs (bool forward)
void lowerObjs (bool backward)
KCommand * setPen (const KoPen &pen, LineEnd lb, LineEnd le, int flags)
KCommand * setBrush (const QBrush &brush, FillType ft, const QColor &g1, const QColor &g2, BCType gt, bool unbalanced, int xfactor, int yfactor, int flags)
KCommand * insertObject (const QString &name, KPrObject *object, const KoRect &r, bool addCommand=true)
virtual KPrPartObjectinsertObject (const KoRect &, KoDocumentEntry &)
void insertRectangle (const KoRect &r, const KoPen &pen, const QBrush &brush, FillType ft, const QColor &g1, const QColor &g2, BCType gt, int rndX, int rndY, bool unbalanced, int xfactor, int yfactor)
void insertCircleOrEllipse (const KoRect &r, const KoPen &pen, const QBrush &brush, FillType ft, const QColor &g1, const QColor &g2, BCType gt, bool unbalanced, int xfactor, int yfactor)
void insertPie (const KoRect &r, const KoPen &pen, const QBrush &brush, FillType ft, const QColor &g1, const QColor &g2, BCType gt, PieType pt, int _angle, int _len, LineEnd lb, LineEnd le, bool unbalanced, int xfactor, int yfactor)
KPrTextObjectinsertTextObject (const KoRect &r, const QString &text=QString::null, KPrView *_view=0L)
void insertLine (const KoRect &r, const KoPen &pen, LineEnd lb, LineEnd le, LineType lt)
void insertAutoform (const KoRect &r, const KoPen &pen, const QBrush &brush, LineEnd lb, LineEnd le, FillType ft, const QColor &g1, const QColor &g2, BCType gt, const QString &fileName, bool unbalanced, int xfactor, int yfactor)
void insertFreehand (const KoPointArray &points, const KoRect &r, const KoPen &pen, LineEnd lb, LineEnd le)
void insertPolyline (const KoPointArray &points, const KoRect &r, const KoPen &pen, LineEnd lb, LineEnd le)
void insertQuadricBezierCurve (const KoPointArray &points, const KoPointArray &allPoints, const KoRect &r, const KoPen &pen, LineEnd lb, LineEnd le)
void insertCubicBezierCurve (const KoPointArray &points, const KoPointArray &allPoints, const KoRect &r, const KoPen &pen, LineEnd lb, LineEnd le)
void insertPolygon (const KoPointArray &points, const KoRect &r, const KoPen &pen, const QBrush &brush, FillType ft, const QColor &g1, const QColor &g2, BCType gt, bool unbalanced, int xfactor, int yfactor, bool _checkConcavePolygon, int _cornersValue, int _sharpnessValue)
void insertClosedLine (const KoPointArray &points, const KoRect &r, const KoPen &pen, const QBrush &brush, FillType ft, const QColor &g1, const QColor &g2, BCType gt, bool unbalanced, int xfactor, int yfactor, ToolEditMode _mode)
void slotRepaintVariable ()
void recalcPageNum ()
void changePicture (const KURL &url, QWidget *parent)
void insertPicture (const QString &filename, const KoPoint &pos)
void insertPicture (const QString &_file, const KoRect &_rect)
void enableEmbeddedParts (bool f)
KPrBackGroundbackground ()
void makeUsedPixmapList ()
void setBackColor (const QColor &backColor1, const QColor &backColor2, BCType bcType, bool unbalanced, int xfactor, int yfactor)
void setBackPicture (const KoPictureKey &key)
bool getBackUnbalanced () const
void setBackView (BackView backView)
void setBackType (BackType backType)
void setPageEffect (PageEffect pageEffect)
void setPageEffectSpeed (EffectSpeed pageEffectSpeed)
void setPageTimer (int pageTimer)
void setPageSoundEffect (bool soundEffect)
void setPageSoundFileName (const QString &fileName)
BackType getBackType () const
BackView getBackView () const
KoPictureKey getBackPictureKey () const
KoPicture getBackPicture () const
QColor getBackColor1 () const
QColor getBackColor2 () const
int getBackXFactor () const
int getBackYFactor () const
BCType getBackColorType () const
PageEffect getPageEffect () const
EffectSpeed getPageEffectSpeed () const
int getPageTimer () const
bool getPageSoundEffect () const
QString getPageSoundFileName () const
void setUseMasterBackground (bool useMasterBackground)
bool useMasterBackground () const
QValueList< int > getEffectSteps () const
bool isSlideSelected () const
void slideSelected (bool _b)
void setInsPictureFile (const QString &_file)
QString insPictureFile () const
void deSelectAllObj ()
void deSelectObj (KPrObject *kpobject)
QDomElement saveObjects (QDomDocument &doc, QDomElement &objects, double yoffset, int saveOnlyPage) const
bool oneObjectTextExist (bool forceAllTextObject=true)
bool oneObjectTextSelected ()
bool isOneObjectSelected ()
bool haveASelectedPartObj ()
bool haveASelectedGroupObj ()
bool haveASelectedPixmapObj ()
KoRect getRealRect (bool all) const
bool chPic (KPrView *_view)
KCommand * moveObject (KPrView *_view, double diffx, double diffy)
KCommand * moveObject (KPrView *m_view, const KoPoint &_move, bool key)
KCommand * rotateSelectedObjects (float _newAngle, bool addAngle=false)
KCommand * shadowObj (ShadowDirection dir, int dist, const QColor &col)
QPtrList< KoTextObject > allTextObjects () const
void addTextObjects (QPtrList< KoTextObject > &lst) const
void repaintObj ()
KPrObjectgetCursor (const QPoint &pos)
KPrObjectgetCursor (const KoPoint &pos)
KPrObjectgetObjectAt (const KoPoint &pos, bool withoutProtected=false) const
KPrPixmapObjectpicViewOrigHelper () const
void applyStyleChange (KoStyleChangeDefMap changed)
void reactivateBgSpellChecking (bool refreshTextObj)
bool canMoveOneObject () const
KCommand * alignVertical (VerticalAlignmentType _type)
void changeTabStopValue (double _tabStop)
bool savePicture (KPrView *_view) const
bool findTextObject (KPrObject *obj)
KPrObjectnextTextObject (KPrTextObject *obj)
void getAllObjectSelectedList (QPtrList< KPrObject > &lst, bool force=false)
void getAllEmbeddedObjectSelected (QPtrList< KoDocumentChild > &embeddedObjects)
void load (const QDomElement &element)
void loadOasis (KoOasisContext &context)
QDomElement save (QDomDocument &doc)
bool saveOasisPage (KoStore *store, KoXmlWriter &xmlWriter, int posPage, KoSavingContext &context, int &indexObj, int &partIndexObj, KoXmlWriter *manifestWriter, QMap< QString, int > &pageNames) const
QString saveOasisPageStyle (KoStore *store, KoGenStyles &mainStyles) const
QString saveOasisPageEffect () const
QString saveOasisAdditionalPageEffect () const
bool saveOasisNote (KoXmlWriter &xmlWriter) const
bool hasHeader () const
bool hasFooter () const
void setHeader (bool b, bool _updateDoc=true)
void setFooter (bool b, bool _updateDoc=true)
void setDisplayObjectFromMasterPage (bool _b)
bool displayObjectFromMasterPage () const
void setDisplayBackground (bool _b)
bool displayBackground () const
QString oasisNamePage (int posPage) const

Constructor & Destructor Documentation

KPrPage::KPrPage ( KPrDocument _doc,
KPrPage masterPage = 0 
)

Constructor.

Parameters:
doc pointer to the kpresenter document
masterPage master page, 0 if it is a master page

Definition at line 77 of file KPrPage.cpp.

KPrPage::~KPrPage (  )  [virtual]

Desctructor.

Definition at line 102 of file KPrPage.cpp.


Member Function Documentation

DCOPObject * KPrPage::dcopObject (  )  [virtual]

Return a DCOP interface for this page.

Definition at line 112 of file KPrPage.cpp.

KPrDocument* KPrPage::kPresenterDoc (  )  const [inline]

Return a DCOP interface for this page.

Definition at line 83 of file KPrPage.h.

QString KPrPage::manualTitle (  )  const

Get the manual title.

Returns:
the manual title

Definition at line 1856 of file KPrPage.cpp.

void KPrPage::insertManualTitle ( const QString &  title  ) 

Set the manual title.

Parameters:
title which sould be set

Definition at line 1861 of file KPrPage.cpp.

QString KPrPage::pageTitle ( const QString &  _title = QString()  )  const

Get the page title.

The page title is found out like following:

  • If a manual title is set the manual title is returned.
  • If there are text objects on the page the title is generated for the first paragraph of top most text object.
  • If a title is passed to the function it is returned
  • Slide PAGENUMBER or Master Slide

Definition at line 1866 of file KPrPage.cpp.

void KPrPage::setNoteText ( const QString &  _text  ) 

Set the note text.

Parameters:
text which should be set

Definition at line 1919 of file KPrPage.cpp.

QString KPrPage::noteText (  )  const

Get the note text.

Returns:
the text of the note

Definition at line 1925 of file KPrPage.cpp.

void KPrPage::setMasterPage ( KPrPage _masterPage  )  [inline]

Set the master page to masterPage.

Parameters:
masterpage to set

Definition at line 130 of file KPrPage.h.

KPrPage* KPrPage::masterPage (  )  const [inline]

Get the master page.

Returns:
the master page, 0 if it is a master page

Definition at line 137 of file KPrPage.h.

bool KPrPage::isMasterPage (  )  const

Check if page is a master page.

Returns:
true if master page

false otherwise

Definition at line 2599 of file KPrPage.cpp.

const QPtrList<KPrObject>& KPrPage::objectList (  )  const [inline]

Get object list.

Returns:
object list

Definition at line 152 of file KPrPage.h.

KPrObject * KPrPage::getObject ( int  num  ) 

Get object at position.

Parameters:
pos position of object
Returns:
object at position num

Definition at line 842 of file KPrPage.cpp.

void KPrPage::appendObject ( KPrObject _obj  ) 

Appends object to page.

Appends the object to the page. The name of the object is unified.

Parameters:
obj object to append

Definition at line 891 of file KPrPage.cpp.

void KPrPage::appendObjects ( const QValueList< KPrObject * > &  objects  ) 

Appends object to page.

Appends the objects to the page. The name of the objects is unified.

Parameters:
obj objects to append

Definition at line 897 of file KPrPage.cpp.

void KPrPage::replaceObject ( KPrObject oldObject,
KPrObject newObject 
)

Replaces an object.

The object oldObject by the object newObject

Parameters:
oldObject object which will be removed from the page
newObject object which will take the place of the oldObject

Definition at line 949 of file KPrPage.cpp.

int KPrPage::takeObject ( KPrObject object  ) 

Take object from page.

Parameters:
object to be take from page
Returns:
the position of the taken object

Definition at line 942 of file KPrPage.cpp.

KCommand * KPrPage::deleteSelectedObjects (  ) 

Delete selected objects from page.

The returned command will be executed.

Returns:
KCommand the command

0 if no object is selected

Definition at line 964 of file KPrPage.cpp.

void KPrPage::insertObject ( KPrObject object,
int  pos 
)

Insert object in page.

Inserts the object at pos to the page. The name of the object is unified.

Parameters:
object to insert
position the object should be insert

Definition at line 958 of file KPrPage.cpp.

void KPrPage::unifyObjectName ( KPrObject object  ) 

Create a uniq name for an object.

Create a uniq name for the object. If no name is set for the object a name according to its type is created. If the name already exists append ' (x)'. // FIXME: not allowed by I18N

Parameters:
object to work on

Definition at line 870 of file KPrPage.cpp.

KoRect KPrPage::getPageRect (  )  const

Get the page rect.

Returns:
the page rect

Definition at line 1764 of file KPrPage.cpp.

QRect KPrPage::getZoomPageRect (  )  const

Get the page rect with applied zoom.

Returns:
the page rect

Definition at line 1770 of file KPrPage.cpp.

void KPrPage::setObjectList ( QPtrList< KPrObject objectLlist  )  [inline]

Set object for the page.

Parameters:
list of objects

Definition at line 258 of file KPrPage.h.

unsigned int KPrPage::objNums (  )  const [inline]

Get the number ob objects on the page.

Returns:
the number of objects on the page

Definition at line 267 of file KPrPage.h.

int KPrPage::numTextObject (  )  const

Get the number of text objects.

The functions in only used by KPrPageIface.

Returns:
the number os text object on the page

Definition at line 1144 of file KPrPage.cpp.

KPrTextObject * KPrPage::textFrameSet ( unsigned int  _num  )  const

Get the text object.

The functions in only used by KPrPageIface.

Parameters:
num the number of the text object to get
Returns:
the text object with the number

0 if no such object exists

Definition at line 1114 of file KPrPage.cpp.

int KPrPage::numSelected (  )  const

Get the amount of selected objects.

Returns:
the amount of select objects

Definition at line 1130 of file KPrPage.cpp.

KPrObject * KPrPage::getSelectedObj (  )  const

Get the first selected object.

Returns:
the first selected object of this page

O if none exists

Definition at line 1158 of file KPrPage.cpp.

QPtrList< KPrObject > KPrPage::getSelectedObjects ( bool  withoutHeaderFooter = false  )  const

Get a list of all selected objects.

Parameters:
withoutHeaderFooter if true a selected header or footer will not be in the list returned.
Returns:
list of selected objets.

Definition at line 1170 of file KPrPage.cpp.

KPrPixmapObject * KPrPage::getSelectedImage (  )  const

Get the first selected pictur.

Returns:
first selected picture

0 if none is selected

Definition at line 2510 of file KPrPage.cpp.

KCommand * KPrPage::setImageEffect ( ImageEffect  eff,
QVariant  param1,
QVariant  param2,
QVariant  param3 
)

Set the image effect for all selected pictures.

Parameters:
eff image effect
param1 effect parameter 1
param1 effect parameter 2
param1 effect parameter 3

Definition at line 2525 of file KPrPage.cpp.

void KPrPage::groupObjects (  ) 

Group selected objects.

This will create a KPrGroupObjCmd, executes it and adds it to the history. If less than 2 objects are selected nothing happens.

Definition at line 1187 of file KPrPage.cpp.

void KPrPage::ungroupObjects ( KMacroCommand **  macro  ) 

Ungroup all selected group objects.

Parameters:
macro to store the commands in

Definition at line 1198 of file KPrPage.cpp.

KCommand * KPrPage::insertObject ( const QString &  name,
KPrObject object,
const KoRect &  r,
bool  addCommand = true 
)

Insert an object into the page.

Definition at line 1294 of file KPrPage.cpp.

QValueList< int > KPrPage::getEffectSteps (  )  const

return the list of steps where objects appear/disappear.

Definition at line 1962 of file KPrPage.cpp.

KoRect KPrPage::getRealRect ( bool  all  )  const

get the rect for the objects

Parameters:
all true if the rect for all objects shoud be returned false if only the rect for selected objects sould be returned
Returns:
rect of the objects

Definition at line 2087 of file KPrPage.cpp.

KPrObject * KPrPage::getObjectAt ( const KoPoint &  pos,
bool  withoutProtected = false 
) const

Returns the object at position pos.

Parameters:
pos the position in the document on which to look
withoutProtected if set to true only unprotecred objects are returned
Returns:
the object at position pos

Definition at line 2326 of file KPrPage.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys