Scribus
Open source desktop publishing at your fingertips
ScPage Class Reference

#include <scpage.h>

Inheritance diagram for ScPage:
Collaboration diagram for ScPage:

Public Member Functions

 ScPage (const double x, const double y, const double b, const double h)
 
double xOffset () const
 
double yOffset () const
 
double width () const
 
double height () const
 
double initialWidth () const
 
double initialHeight () const
 
int orientation () const
 
void setXOffset (const double)
 
void setYOffset (const double)
 
void setWidth (const double)
 
void setHeight (const double)
 
void setInitialWidth (const double)
 
void setInitialHeight (const double)
 
void setOrientation (int)
 
void copySizingProperties (ScPage *sourcePage, const MarginStruct &pageMargins)
 
MarginStruct margins () const
 
double leftMargin () const
 
double topMargin () const
 
double bottomMargin () const
 
double rightMargin () const
 
ScribusDocdoc () const
 
void setDocument (ScribusDoc *doc)
 
int pageNr () const
 
void setPageNr (int pageNr)
 
const QString & pageSectionNumber () const
 
void setPageSectionNumber (const QString &)
 
const QString & pageName () const
 Return the page's name.
 
void setPageName (const QString &newName)
 
void restore (UndoState *state, bool isUndo)
 Method used when an undo/redo is requested. More...
 
- Public Member Functions inherited from UndoObject
 UndoObject ()
 Creates a new anonymous UndoObject instance.
 
 UndoObject (const UndoObject &other)
 Creates a copy of an UndoObject instance.
 
 UndoObject (const QString &objectName, QPixmap *objectIcon=0)
 Creates a new UndoObject instance with the name objectName More...
 
virtual ~UndoObject ()
 Destroys the object.
 
virtual QString getUName ()
 Returns the name of the UndoObject. More...
 
virtual void setUName (QString newUName)
 Set the name of the UndoObject. More...
 
virtual QPixmap * getUPixmap ()
 Returns the pixmap connected to this object. More...
 
virtual void setUPixmap (QPixmap *newUPixmap)
 Set the pixmap for this object. More...
 
ulong getUId () const
 Returns an unique identifier number for the UndoObject. More...
 
const ScGuardedPtr< UndoObject > & undoObjectPtr ()
 Returns a guarded pointer.
 
- Public Member Functions inherited from SingleObservable< ScPage >
 SingleObservable (MassObservable< ScPage * > *massObservable)
 
void setMassObservable (MassObservable< ScPage * > *massObservable)
 
virtual void update ()
 
virtual void updateLayout ()
 

Public Attributes

MarginStruct Margins
 
MarginStruct initialMargins
 
int LeftPg
 
QString MPageNam
 Name of the master page that this page uses.
 
QString m_pageSize
 
int marginPreset
 
QList< PageItem * > FromMaster
 As a bit of a dirty hack, we declare this mutable so it can be altered even while the object is `const'. That's normally only for internal implementation, but in this case it at least lets us guarantee the rest of the object is unchanged in (eg) pdflib. This should be replaced with proper access methods later.
 
GuideManagerCore guides
 Guides lists and basic operations.
 
PDFPresentationData PresentVals
 

Protected Member Functions

void restorePageItemCreation (ScItemState< PageItem * > *state, bool isUndo)
 
void restorePageItemDeletion (ScItemState< QList< PageItem * > > *state, bool isUndo)
 
void restorePageAttributes (SimpleState *state, bool isUndo)
 
void restorePageItemConversion (ScItemState< std::pair< PageItem *, PageItem * > > *state, bool isUndo)
 
void restorePageItemConversionToSymbol (ScItemState< std::pair< PageItem *, PageItem * > > *state, bool isUndo)
 

Protected Attributes

UndoManager *const undoManager
 
double m_xOffset
 
double m_yOffset
 
double m_width
 
double m_height
 
double m_initialWidth
 
double m_initialHeight
 
int m_pageNr
 
int m_orientation
 
QString m_PageName
 Name of this page, currently only allowed to be used by a master page.
 
ScribusDocm_Doc
 
QString m_pageSectionNumber
 

Detailed Description

Author
Franz Schmid

Member Function Documentation

void ScPage::restore ( UndoState state,
bool  isUndo 
)
virtual

Method used when an undo/redo is requested.

UndoObject must know how to handle the UndoState object given as a parameter. It is the same object that was send from the UndoObject to the UndoManager when the action happened.

Parameters
stateState describing the action that is wanted to be undone/redone
isUndoIf true undo is wanted else if false redo.

Implements UndoObject.

Member Data Documentation

int ScPage::LeftPg

Nummer der Seite


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