Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

CanvasMode Class Reference

#include <canvasmode.h>

Inheritance diagram for CanvasMode:

Inheritance graph
[legend]
Collaboration diagram for CanvasMode:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void activate (bool fromGesture)
virtual void deactivate (bool forGesture)
virtual void enterEvent (QEvent *)
virtual void leaveEvent (QEvent *)
virtual void dragEnterEvent (QDragEnterEvent *e)
virtual void dragMoveEvent (QDragMoveEvent *e)
virtual void dragLeaveEvent (QDragLeaveEvent *e)
virtual void dropEvent (QDropEvent *e)
virtual void mouseDoubleClickEvent (QMouseEvent *m)
virtual void mouseReleaseEvent (QMouseEvent *m)
virtual void mouseMoveEvent (QMouseEvent *m)
virtual void mousePressEvent (QMouseEvent *m)
virtual void keyPressEvent (QKeyEvent *e)
virtual void keyReleaseEvent (QKeyEvent *e)
virtual void inputMethodEvent (QInputMethodEvent *e)
virtual void updateViewMode (CanvasViewMode *viewmode)
virtual void drawControls (QPainter *p)
void drawSelection (QPainter *psx)
void drawOutline (QPainter *p, double scalex=1.0, double scaley=1.0, double deltax=0.0, double deltay=0.0)
void setModeCursor ()
virtual CanvasModedelegate ()
ScribusViewview () const
virtual ~CanvasMode ()

Static Public Member Functions

static CanvasModecreateForAppMode (ScribusView *view, int appMode)

Protected Member Functions

 CanvasMode (ScribusView *view)

Protected Attributes

ScribusView *const m_view
Canvas *const m_canvas
ScribusDoc *const m_doc


Detailed Description

This class is a superclass for all mode handlers. By default, all events are ignored.

Definition at line 56 of file canvasmode.h.


Constructor & Destructor Documentation

CanvasMode::CanvasMode ( ScribusView view  )  [protected]

Definition at line 33 of file canvasmode.cpp.

virtual CanvasMode::~CanvasMode (  )  [inline, virtual]

Definition at line 115 of file canvasmode.h.


Member Function Documentation

CanvasMode * CanvasMode::createForAppMode ( ScribusView view,
int  appMode 
) [static]

virtual void CanvasMode::activate ( bool  fromGesture  )  [inline, virtual]

Is called when this mode becomes active, either because it was selected by the user (fromgesture == false) or because a gesture completed and the canvas returns back to this mode (fromGesture == true)

Reimplemented in LineMove, RectSelect, ResizeGesture, RulerGesture, CreateMode, BezierMode, FreehandMode, LegacyMode, MeasurementsMode, and CanvasMode_NodeEdit.

Definition at line 69 of file canvasmode.h.

Referenced by ScribusView::startGesture(), and ScribusView::stopGesture().

virtual void CanvasMode::deactivate ( bool  forGesture  )  [inline, virtual]

Is called when this mode becomes inactive, either because the canvas switches to another mode (forGesture == false) or because a gesture is activated (forGesture == true)

Reimplemented in LineMove, RectSelect, ResizeGesture, RulerGesture, CreateMode, BezierMode, FreehandMode, LegacyMode, MeasurementsMode, and CanvasMode_NodeEdit.

Definition at line 74 of file canvasmode.h.

Referenced by ScribusView::startGesture(), ScribusView::stopGesture(), and ScribusView::~ScribusView().

virtual void CanvasMode::enterEvent ( QEvent *   )  [inline, virtual]

virtual void CanvasMode::leaveEvent ( QEvent *   )  [inline, virtual]

virtual void CanvasMode::dragEnterEvent ( QDragEnterEvent *  e  )  [inline, virtual]

Reimplemented in CanvasGesture.

Definition at line 79 of file canvasmode.h.

virtual void CanvasMode::dragMoveEvent ( QDragMoveEvent *  e  )  [inline, virtual]

Reimplemented in CanvasGesture.

Definition at line 80 of file canvasmode.h.

virtual void CanvasMode::dragLeaveEvent ( QDragLeaveEvent *  e  )  [inline, virtual]

Reimplemented in CanvasGesture.

Definition at line 81 of file canvasmode.h.

virtual void CanvasMode::dropEvent ( QDropEvent *  e  )  [inline, virtual]

Reimplemented in CanvasGesture.

Definition at line 82 of file canvasmode.h.

virtual void CanvasMode::mouseDoubleClickEvent ( QMouseEvent *  m  )  [inline, virtual]

Reimplemented in CanvasGesture, CreateMode, BezierMode, FreehandMode, LegacyMode, and CanvasMode_NodeEdit.

Definition at line 84 of file canvasmode.h.

Referenced by ScribusView::eventFilter().

virtual void CanvasMode::mouseReleaseEvent ( QMouseEvent *  m  )  [inline, virtual]

virtual void CanvasMode::mouseMoveEvent ( QMouseEvent *  m  )  [inline, virtual]

virtual void CanvasMode::mousePressEvent ( QMouseEvent *  m  )  [inline, virtual]

virtual void CanvasMode::keyPressEvent ( QKeyEvent *  e  )  [inline, virtual]

Reimplemented in CanvasGesture.

Definition at line 89 of file canvasmode.h.

virtual void CanvasMode::keyReleaseEvent ( QKeyEvent *  e  )  [inline, virtual]

Reimplemented in CanvasGesture.

Definition at line 90 of file canvasmode.h.

virtual void CanvasMode::inputMethodEvent ( QInputMethodEvent *  e  )  [inline, virtual]

Reimplemented in CanvasGesture.

Definition at line 91 of file canvasmode.h.

void CanvasMode::updateViewMode ( CanvasViewMode viewmode  )  [virtual]

Sets appropiate values for this canvas mode

Definition at line 87 of file canvasmode.cpp.

References CanvasViewMode::drawFramelinksWithContents, and CanvasViewMode::drawSelectedItemsWithControls.

virtual void CanvasMode::drawControls ( QPainter *  p  )  [inline, virtual]

Draws the controls for this mode and the selection marker. If viewmode.drawSelectionWithControls is true, also draws the selection contents first.

Reimplemented in LineMove, ResizeGesture, RulerGesture, CreateMode, BezierMode, FreehandMode, LegacyMode, MeasurementsMode, and CanvasMode_NodeEdit.

Definition at line 102 of file canvasmode.h.

Referenced by Canvas::paintEvent().

void CanvasMode::drawSelection ( QPainter *  psx  ) 

void CanvasMode::drawOutline ( QPainter *  p,
double  scalex = 1.0,
double  scaley = 1.0,
double  deltax = 0.0,
double  deltay = 0.0 
)

void CanvasMode::setModeCursor (  ) 

virtual CanvasMode* CanvasMode::delegate (  )  [inline, virtual]

main canvas modes dont have a delegate

Reimplemented in CanvasGesture.

Definition at line 113 of file canvasmode.h.

Referenced by ScribusView::stopGesture(), and ScribusView::~ScribusView().

ScribusView* CanvasMode::view (  )  const [inline]

Definition at line 114 of file canvasmode.h.


Member Data Documentation

ScribusView* const CanvasMode::m_view [protected]

Definition at line 119 of file canvasmode.h.

Referenced by LegacyMode::activate(), CreateMode::activate(), LineMove::adjustBounds(), CanvasMode_NodeEdit::CanvasMode_NodeEdit(), LegacyMode::createContextMenu(), LegacyMode::deactivate(), FreehandMode::deactivate(), BezierMode::deactivate(), CreateMode::deactivate(), CanvasMode_NodeEdit::drawControls(), CanvasMode_NodeEdit::handleNodeEditDrag(), CanvasMode_NodeEdit::handleNodeEditPress(), LegacyMode::HandleSizer(), LegacyMode::importToPage(), MeasurementsMode::MeasurementsMode(), CanvasMode_NodeEdit::mouseDoubleClickEvent(), LegacyMode::mouseDoubleClickEvent(), CanvasMode_NodeEdit::mouseMoveEvent(), LegacyMode::mouseMoveEvent(), FreehandMode::mouseMoveEvent(), BezierMode::mouseMoveEvent(), CreateMode::mouseMoveEvent(), ResizeGesture::mouseMoveEvent(), CanvasMode_NodeEdit::mousePressEvent(), LegacyMode::mousePressEvent(), FreehandMode::mousePressEvent(), BezierMode::mousePressEvent(), CreateMode::mousePressEvent(), CanvasMode_NodeEdit::mouseReleaseEvent(), LegacyMode::mouseReleaseEvent(), FreehandMode::mouseReleaseEvent(), BezierMode::mouseReleaseEvent(), CreateMode::mouseReleaseEvent(), RulerGesture::mouseReleaseEvent(), ResizeGesture::mouseReleaseEvent(), RectSelect::mouseReleaseEvent(), LineMove::mouseReleaseEvent(), RulerGesture::movePoint(), LegacyMode::selectPage(), FreehandMode::selectPage(), BezierMode::selectPage(), CreateMode::selectPage(), LegacyMode::SeleItem(), MeasurementsMode::setActive(), setModeCursor(), LegacyMode::SetupDraw(), CreateMode::SetupDraw(), and LegacyMode::SetupDrawNoResize().

Canvas* const CanvasMode::m_canvas [protected]

Definition at line 120 of file canvasmode.h.

Referenced by CanvasMode_NodeEdit::activate(), LegacyMode::activate(), ResizeGesture::adjustBounds(), LineMove::adjustBounds(), MeasurementsMode::adjustPoint(), LegacyMode::blinkTextCursor(), CanvasMode_NodeEdit::drawControls(), LegacyMode::drawControls(), RulerGesture::drawControls(), ResizeGesture::drawControls(), LineMove::drawControls(), drawOutline(), drawSelection(), CanvasMode_NodeEdit::enterEvent(), LegacyMode::enterEvent(), CanvasMode_NodeEdit::handleNodeEditDrag(), CanvasMode_NodeEdit::handleNodeEditMove(), CanvasMode_NodeEdit::handleNodeEditPress(), LegacyMode::HandleSizer(), CanvasMode_NodeEdit::leaveEvent(), LegacyMode::leaveEvent(), CanvasMode_NodeEdit::mouseDoubleClickEvent(), LegacyMode::mouseDoubleClickEvent(), FreehandMode::mouseDoubleClickEvent(), BezierMode::mouseDoubleClickEvent(), CreateMode::mouseDoubleClickEvent(), RulerGesture::mouseHitsGuide(), CanvasMode_NodeEdit::mouseMoveEvent(), LegacyMode::mouseMoveEvent(), FreehandMode::mouseMoveEvent(), BezierMode::mouseMoveEvent(), CreateMode::mouseMoveEvent(), ResizeGesture::mouseMoveEvent(), LineMove::mouseMoveEvent(), CanvasMode_NodeEdit::mousePressEvent(), LegacyMode::mousePressEvent(), FreehandMode::mousePressEvent(), BezierMode::mousePressEvent(), CreateMode::mousePressEvent(), RulerGesture::mousePressEvent(), ResizeGesture::mousePressEvent(), LineMove::mousePressEvent(), CanvasMode_NodeEdit::mouseReleaseEvent(), LegacyMode::mouseReleaseEvent(), FreehandMode::mouseReleaseEvent(), BezierMode::mouseReleaseEvent(), CreateMode::mouseReleaseEvent(), RulerGesture::mouseReleaseEvent(), ResizeGesture::mouseReleaseEvent(), LineMove::mouseReleaseEvent(), RulerGesture::movePoint(), RectSelect::result(), LegacyMode::selectPage(), FreehandMode::selectPage(), BezierMode::selectPage(), CreateMode::selectPage(), LegacyMode::SeleItem(), LegacyMode::SetupDraw(), CreateMode::SetupDraw(), and MeasurementsMode::showValues().

ScribusDoc* const CanvasMode::m_doc [protected]

Definition at line 121 of file canvasmode.h.

Referenced by CanvasMode_NodeEdit::activate(), LegacyMode::activate(), CreateMode::activate(), ResizeGesture::adjustBounds(), LineMove::adjustBounds(), MeasurementsMode::adjustPoint(), LegacyMode::blinkTextCursor(), LegacyMode::createContextMenu(), ResizeGesture::doResize(), CanvasMode_NodeEdit::drawControls(), LegacyMode::drawControls(), RulerGesture::drawControls(), LineMove::drawControls(), drawOutline(), drawSelection(), CanvasMode_NodeEdit::GetItem(), LegacyMode::GetItem(), FreehandMode::GetItem(), BezierMode::GetItem(), CreateMode::GetItem(), CanvasMode_NodeEdit::handleNodeEditDrag(), CanvasMode_NodeEdit::handleNodeEditMove(), CanvasMode_NodeEdit::handleNodeEditPress(), LegacyMode::HandleSizer(), LegacyMode::importToPage(), LegacyMode::mouseDoubleClickEvent(), RulerGesture::mouseHitsGuide(), CanvasMode_NodeEdit::mouseMoveEvent(), LegacyMode::mouseMoveEvent(), FreehandMode::mouseMoveEvent(), BezierMode::mouseMoveEvent(), CreateMode::mouseMoveEvent(), ResizeGesture::mouseMoveEvent(), CanvasMode_NodeEdit::mousePressEvent(), LegacyMode::mousePressEvent(), FreehandMode::mousePressEvent(), BezierMode::mousePressEvent(), CreateMode::mousePressEvent(), ResizeGesture::mousePressEvent(), LineMove::mousePressEvent(), CanvasMode_NodeEdit::mouseReleaseEvent(), LegacyMode::mouseReleaseEvent(), FreehandMode::mouseReleaseEvent(), BezierMode::mouseReleaseEvent(), CreateMode::mouseReleaseEvent(), ResizeGesture::mouseReleaseEvent(), LineMove::mouseReleaseEvent(), RulerGesture::movePoint(), ResizeGesture::prepare(), LegacyMode::selectPage(), FreehandMode::selectPage(), BezierMode::selectPage(), CreateMode::selectPage(), LegacyMode::SeleItem(), setModeCursor(), LegacyMode::SetupDraw(), CreateMode::SetupDraw(), LegacyMode::SetupDrawNoResize(), CreateMode::SetupDrawNoResize(), and MeasurementsMode::showValues().


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.