Ipelib
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ipe::CanvasBase Class Referenceabstract

#include <ipecanvas.h>

Inherited by ipe::Canvas, ipe::Canvas, and ipe::Canvas.

Classes

struct  Style
 

Public Types

enum  TModifiers { EShift = 0x100, EControl = 0x200, EAlt = 0x400, EMeta = 0x800 }
 
enum  TCursor { EStandardCursor, EHandCursor, ECrossCursor, EDotCursor }
 

Public Member Functions

virtual ~CanvasBase ()
 
void setPage (const Page *page, int pno, int view, const Cascade *sheet)
 
void setFontPool (const FontPool *fontPool)
 
Vector pan () const
 
double zoom () const
 
const Cascadecascade () const
 
Vector center () const
 
Vector pos () const
 
Vector unsnappedPos () const
 
Vector globalPos () const
 
Vector simpleSnapPos () const
 
const Snapsnap () const
 
int additionalModifiers () const
 
void setAdditionalModifiers (int mod)
 
Vector devToUser (const Vector &arg) const
 
Vector userToDev (const Vector &arg) const
 
void setCanvasStyle (const Style &style)
 
Style canvasStyle () const
 
void setPan (const Vector &v)
 
void setZoom (double zoom)
 
void setSnap (const Snap &s)
 
void setDimmed (bool dimmed)
 
void setAutoOrigin (const Vector &v)
 
Matrix canvasTfm () const
 
void setRetina (int r)
 
void setObserver (CanvasObserver *observer)
 
void setFifiVisible (bool visible)
 
void setSelectionVisible (bool visible)
 
void setTool (Tool *tool)
 
void finishTool ()
 
Tooltool ()
 
void update ()
 
void updateTool ()
 
int canvasWidth () const
 
int canvasHeight () const
 
virtual void setCursor (TCursor cursor, double w=1.0, Color *color=0)=0
 
virtual void invalidate (int x, int y, int w, int h)=0
 

Static Public Member Functions

static int selectPageOrView (Document *doc, int page=-1, int startIndex=0, int pageWidth=240, int width=600, int height=480)
 

Protected Member Functions

 CanvasBase ()
 
void drawPaper (cairo_t *cc)
 
void drawFrame (cairo_t *cc)
 
void drawAxes (cairo_t *cc)
 
void drawGrid (cairo_t *cc)
 
void drawObjects (cairo_t *cc)
 
void drawTool (Painter &painter)
 
void snapToPaperAndFrame ()
 
void refreshSurface ()
 
void computeFifi (double x, double y)
 
void drawFifi (cairo_t *cr)
 
virtual void invalidate ()=0
 

Protected Attributes

CanvasObserveriObserver
 
TooliTool
 
const PageiPage
 
int iPageNumber
 
int iView
 
const CascadeiCascade
 
Style iStyle
 
Vector iPan
 
double iZoom
 
Snap iSnap
 
bool iDimmed
 
bool iAutoSnap
 
Vector iAutoOrigin
 
int iAdditionalModifiers
 
int iRetina
 
bool iRepaintObjects
 
int iWidth
 
int iHeight
 
cairo_surface_t * iSurface
 
Vector iUnsnappedMousePos
 
Vector iMousePos
 
Vector iGlobalPos
 
Vector iOldFifi
 
bool iFifiVisible
 
Snap::TSnapModes iFifiMode
 
bool iSelectionVisible
 
FontsiFonts
 

Member Enumeration Documentation

Keyboard modifiers.

Enumerator
EShift 
EControl 
EAlt 
EMeta 
Enumerator
EStandardCursor 
EHandCursor 
ECrossCursor 
EDotCursor 

Constructor & Destructor Documentation

CanvasBase::~CanvasBase ( )
virtual

destructor.

References iFonts, iSurface, and iTool.

CanvasBase::CanvasBase ( )
protected

Construct a new canvas.

Member Function Documentation

void CanvasBase::setPage ( const Page page,
int  pno,
int  view,
const Cascade sheet 
)

Set the page to be displayed.

Doesn't take ownership of any argument. The page number pno is only needed if page numbering is turned on.

References iCascade, iPage, iPageNumber, and iView.

void CanvasBase::setFontPool ( const FontPool *  fontPool)

set information about Latex fonts (from ipe::Document)

References iFonts, and ipe::Fonts::New().

Vector ipe::CanvasBase::pan ( ) const
inline

Return current pan.

References iPan.

Referenced by ipe::PanTool::mouseButton().

double ipe::CanvasBase::zoom ( ) const
inline

Return current zoom.

References iZoom.

Referenced by ipe::SelectTool::draw(), ipe::SelectTool::SelectTool(), and setZoom().

const Cascade* ipe::CanvasBase::cascade ( ) const
inline

Return current style sheet cascade.

References iCascade.

Referenced by ipe::PanTool::draw().

Vector ipe::CanvasBase::center ( ) const
inline

Return center of canvas.

References iHeight, and iWidth.

Referenced by canvasTfm(), devToUser(), and userToDev().

Vector ipe::CanvasBase::pos ( ) const
inline

Return last mouse position (snapped!) in user coordinates.

References iMousePos.

Referenced by ipe::TransformTool::mouseButton(), ipe::TransformTool::mouseMove(), simpleSnapPos(), and ipe::TransformTool::TransformTool().

Vector ipe::CanvasBase::unsnappedPos ( ) const
inline

Return last unsnapped mouse position in user coordinates.

References iUnsnappedMousePos.

Referenced by ipe::PanTool::mouseButton(), ipe::PanTool::mouseMove(), ipe::SelectTool::mouseMove(), ipe::PanTool::PanTool(), and ipe::SelectTool::SelectTool().

Vector ipe::CanvasBase::globalPos ( ) const
inline

Return global mouse position of last mouse press/release.

References iGlobalPos.

Referenced by ipe::Canvas::tabletEvent().

Vector CanvasBase::simpleSnapPos ( ) const

Return snapped mouse position without angular snapping.

References iPage, iSnap, ipe::Snap::iSnapDistance, iUnsnappedMousePos, iZoom, pos(), and ipe::Snap::simpleSnap().

const Snap& ipe::CanvasBase::snap ( ) const
inline

Return current snapping information.

References iSnap.

Referenced by snapToPaperAndFrame(), and ipe::TransformTool::TransformTool().

int ipe::CanvasBase::additionalModifiers ( ) const
inline

Return current additional modifiers.

References iAdditionalModifiers.

void CanvasBase::setAdditionalModifiers ( int  mod)

Set additional modifiers.

These modifier bits are passed to the Tool when a key is pressed or a drawing action is performed in addition to the actual keyboard modifiers.

References iAdditionalModifiers.

Vector CanvasBase::devToUser ( const Vector arg) const

Convert canvas (device) coordinates to user coordinates.

References center(), iPan, iZoom, ipe::Vector::x, and ipe::Vector::y.

Referenced by computeFifi(), and drawGrid().

Vector CanvasBase::userToDev ( const Vector arg) const

Convert user coordinates to canvas (device) coordinates.

References center(), iPan, iZoom, ipe::Vector::x, and ipe::Vector::y.

Referenced by computeFifi(), ipe::Canvas::drawFifi(), and drawFifi().

void CanvasBase::setCanvasStyle ( const Style style)

Set style of canvas drawing.

Includes paper color, pretty text, and grid.

References iStyle.

Style ipe::CanvasBase::canvasStyle ( ) const
inline

Return canvas style.

References iStyle.

void CanvasBase::setPan ( const Vector v)

Set current pan position.

The pan position is the user coordinate that is displayed at the very center of the canvas.

References iPan.

Referenced by ipe::PanTool::mouseButton().

void CanvasBase::setZoom ( double  zoom)

Set current zoom factor.

The zoom factor maps user coordinates to screen pixel coordinates.

References iZoom, and zoom().

void CanvasBase::setSnap ( const Snap s)

Set the snapping information.

References iSnap.

void CanvasBase::setDimmed ( bool  dimmed)

Dim whole canvas, except for the Tool.

This mode will be reset when the Tool finishes.

References iDimmed.

void CanvasBase::setAutoOrigin ( const Vector v)

Enable automatic angular snapping with this origin.

References iAutoOrigin, and iAutoSnap.

Referenced by ipe::TransformTool::TransformTool().

Matrix CanvasBase::canvasTfm ( ) const

Matrix mapping user coordinates to canvas coordinates.

References center(), iPan, and iZoom.

Referenced by ipe::Canvas::paintEvent().

void CanvasBase::setRetina ( int  r)

Set MacOS Retina display.

References iRetina, and update().

void CanvasBase::setObserver ( CanvasObserver observer)

Set an observer.

Use 0 to delete current observer.

References iObserver.

void CanvasBase::setFifiVisible ( bool  visible)

Set whether Fifi should be shown.

Fifi will only be shown if a snapping mode is active.

References iFifiVisible, and updateTool().

void CanvasBase::setSelectionVisible ( bool  visible)

Set whether selection should be shown when there is no tool.

References iSelectionVisible, and updateTool().

void CanvasBase::setTool ( Tool tool)

Set a new tool.

Calls canvasObserverToolChanged().

References ipe::CanvasObserver::canvasObserverToolChanged(), iObserver, iTool, tool(), and updateTool().

void CanvasBase::finishTool ( )
Tool* ipe::CanvasBase::tool ( )
inline

References iTool.

Referenced by setTool().

void CanvasBase::update ( )

Mark for update with redrawing of objects.

References invalidate(), and iRepaintObjects.

Referenced by finishTool(), and setRetina().

void CanvasBase::updateTool ( )
int ipe::CanvasBase::canvasWidth ( ) const
inline

References iWidth.

int ipe::CanvasBase::canvasHeight ( ) const
inline

References iHeight.

virtual void ipe::CanvasBase::setCursor ( TCursor  cursor,
double  w = 1.0,
Color color = 0 
)
pure virtual
int CanvasBase::selectPageOrView ( Document doc,
int  page = -1,
int  startIndex = 0,
int  pageWidth = 240,
int  width = 600,
int  height = 480 
)
static

Show dialog to select a page or a view.

If page is negative (the default), shows thumbnails of all pages of the document in a dialog. If the user selects a page, the page number is returned. If the dialog is canceled, -1 is returned.

If page is non-negative, all views of this page are shown, and the selected view number is returned.

itemWidth is the width of the page thumbnails (the height is computed automatically).

If page is negative (the default), shows thumbnails of all pages of the document in a dialog. If the user selects a page, the page number is returned. If the dialog is canceled, -1 is returned.

If page is non-negative, all views of this page are shown, and the selected view number is returned.

References ipe::Document::countPages(), ipe::Page::countViews(), and ipe::Document::page().

virtual void ipe::CanvasBase::invalidate ( int  x,
int  y,
int  w,
int  h 
)
pure virtual

Implemented in ipe::Canvas.

void CanvasBase::drawPaper ( cairo_t *  cc)
protected
void CanvasBase::drawFrame ( cairo_t *  cc)
protected
void CanvasBase::drawAxes ( cairo_t *  cc)
protected
void CanvasBase::drawGrid ( cairo_t *  cc)
protected
void CanvasBase::drawObjects ( cairo_t *  cc)
protected
void CanvasBase::drawTool ( Painter painter)
protected
void CanvasBase::snapToPaperAndFrame ( )
protected
void CanvasBase::refreshSurface ( )
protected
void CanvasBase::computeFifi ( double  x,
double  y 
)
protected
void CanvasBase::drawFifi ( cairo_t *  cr)
protected
virtual void ipe::CanvasBase::invalidate ( )
protectedpure virtual

Implemented in ipe::Canvas.

Referenced by computeFifi(), update(), and updateTool().

Member Data Documentation

CanvasObserver* ipe::CanvasBase::iObserver
protected
Tool* ipe::CanvasBase::iTool
protected
const Page* ipe::CanvasBase::iPage
protected
int ipe::CanvasBase::iPageNumber
protected

Referenced by drawObjects(), and setPage().

int ipe::CanvasBase::iView
protected

Referenced by drawObjects(), drawTool(), and setPage().

const Cascade* ipe::CanvasBase::iCascade
protected
Style ipe::CanvasBase::iStyle
protected
Vector ipe::CanvasBase::iPan
protected
double ipe::CanvasBase::iZoom
protected
Snap ipe::CanvasBase::iSnap
protected
bool ipe::CanvasBase::iDimmed
protected

Referenced by drawObjects(), finishTool(), and setDimmed().

bool ipe::CanvasBase::iAutoSnap
protected
Vector ipe::CanvasBase::iAutoOrigin
protected

Referenced by computeFifi(), and setAutoOrigin().

int ipe::CanvasBase::iAdditionalModifiers
protected
int ipe::CanvasBase::iRetina
protected
bool ipe::CanvasBase::iRepaintObjects
protected

Referenced by refreshSurface(), and update().

int ipe::CanvasBase::iWidth
protected
int ipe::CanvasBase::iHeight
protected
cairo_surface_t* ipe::CanvasBase::iSurface
protected
Vector ipe::CanvasBase::iUnsnappedMousePos
protected
Vector ipe::CanvasBase::iMousePos
protected
Vector ipe::CanvasBase::iGlobalPos
protected
Vector ipe::CanvasBase::iOldFifi
protected
bool ipe::CanvasBase::iFifiVisible
protected
Snap::TSnapModes ipe::CanvasBase::iFifiMode
protected
bool ipe::CanvasBase::iSelectionVisible
protected
Fonts* ipe::CanvasBase::iFonts
protected

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