Widget to display the composer items. More...

#include <qgscomposerview.h>

Collaboration diagram for QgsComposerView:

Public Types
enum	Tool { Select = 0, AddArrow, AddMap, AddLegend, AddLabel, AddScalebar, AddPicture, AddRectangle, AddEllipse, AddTriangle, AddTable, MoveItemContent }
	Current tool. More...
Signals
void	selectedItemChanged (QgsComposerItem *selected)
	Is emitted when selected item changed.
void	itemRemoved (QgsComposerItem *)
void	actionFinished ()
	Current action (e.g.
void	composerViewShow (QgsComposerView *)
	Emitted before composerview is shown.
void	composerViewHide (QgsComposerView *)
	Emitted before composerview is hidden.
Public Member Functions
	QgsComposerView (QWidget parent=0, const char name=0, Qt::WFlags f=0)
void	groupItems ()
	Add an item group containing the selected items.
void	ungroupItems ()
	Ungroups the selected items.
QgsComposerView::Tool	currentTool () const
void	setCurrentTool (QgsComposerView::Tool t)
void	setComposition (QgsComposition *c)
	Sets composition (derived from QGraphicsScene)
QgsComposition *	composition ()
	Returns the composition or 0 in case of error.
QMainWindow *	composerWindow ()
	Returns the composer main window.
void	setPaintingEnabled (bool enabled)
bool	paintingEnabled () const
Protected Member Functions
void	mousePressEvent (QMouseEvent *)
void	mouseReleaseEvent (QMouseEvent *)
void	mouseMoveEvent (QMouseEvent *)
void	mouseDoubleClickEvent (QMouseEvent *e)
void	keyPressEvent (QKeyEvent *e)
void	keyReleaseEvent (QKeyEvent *e)
void	wheelEvent (QWheelEvent *event)
void	paintEvent (QPaintEvent *event)
void	hideEvent (QHideEvent *e)
void	showEvent (QShowEvent *e)
Private Member Functions
void	addShape (Tool currentTool)
	Draw a shape on the canvas.
Private Attributes
bool	mShiftKeyPressed
	Status of shift key (used for multiple selection)
QgsComposerView::Tool	mCurrentTool
	Current composer tool.
QGraphicsRectItem *	mRubberBandItem
	Rubber band item.
QGraphicsLineItem *	mRubberBandLineItem
	Rubber band item for arrows.
QgsComposerItem *	mMoveContentItem
	Item to move content.
QPointF	mMoveContentStartPos
	Start position of content move.
QPointF	mRubberBandStartPos
	Start of rubber band creation.
bool	mPaintingEnabled

Detailed Description

Widget to display the composer items.

Manages the composer tools and the mouse/key events. Creates the composer items according to the current map tools and keeps track of the rubber band item.

Definition at line 46 of file qgscomposerview.h.

Member Enumeration Documentation

enum QgsComposerView::Tool

Current tool.

Enumerator:

Select
AddArrow
AddMap
AddLegend
AddLabel
AddScalebar
AddPicture
AddRectangle
AddEllipse
AddTriangle
AddTable
MoveItemContent

Definition at line 53 of file qgscomposerview.h.

Constructor & Destructor Documentation

QgsComposerView::QgsComposerView	(	QWidget *	parent = `0`,
		const char *	name = `0`,
		Qt::WFlags	f = `0`
	)

Definition at line 37 of file qgscomposerview.cpp.

Member Function Documentation

void QgsComposerView::actionFinished ( ) [signal]

Current action (e.g.

adding composer map) has been finished. The purpose of this signal is that QgsComposer may set the selection tool again

Referenced by addShape(), mousePressEvent(), and mouseReleaseEvent().

void QgsComposerView::addShape ( Tool currentTool ) [private]

Draw a shape on the canvas.

Definition at line 209 of file qgscomposerview.cpp.

References actionFinished(), QgsComposition::addComposerShape(), AddRectangle, AddTriangle, composition(), QgsComposerShape::Ellipse, mRubberBandItem, QgsComposition::pushAddRemoveCommand(), QgsComposerShape::Rectangle, QgsComposerShape::setShapeType(), and QgsComposerShape::Triangle.

Referenced by mouseReleaseEvent().

void QgsComposerView::composerViewHide ( QgsComposerView * ) [signal]

Emitted before composerview is hidden.

Referenced by hideEvent().

void QgsComposerView::composerViewShow ( QgsComposerView * ) [signal]

Emitted before composerview is shown.

Referenced by showEvent().

QMainWindow * QgsComposerView::composerWindow ( )

Returns the composer main window.

Definition at line 647 of file qgscomposerview.cpp.

QgsComposition * QgsComposerView::composition ( )

Returns the composition or 0 in case of error.

Definition at line 587 of file qgscomposerview.cpp.

Referenced by addShape(), groupItems(), keyPressEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), ungroupItems(), and wheelEvent().

QgsComposerView::Tool QgsComposerView::currentTool ( ) const [inline]

Definition at line 77 of file qgscomposerview.h.

void QgsComposerView::groupItems ( )

Add an item group containing the selected items.

Definition at line 600 of file qgscomposerview.cpp.

References QgsComposerItemGroup::addItem(), composition(), QgsComposition::selectedComposerItems(), selectedItemChanged(), and QgsComposerItem::setSelected().

void QgsComposerView::hideEvent ( QHideEvent * e ) [protected]

Definition at line 570 of file qgscomposerview.cpp.

References composerViewHide().

void QgsComposerView::itemRemoved ( QgsComposerItem * ) [signal]

Referenced by ungroupItems().

void QgsComposerView::keyPressEvent ( QKeyEvent * e ) [protected]

Definition at line 426 of file qgscomposerview.cpp.

References QgsComposition::addItemsFromXML(), composition(), QgsComposerItemGroup::items(), mShiftKeyPressed, QgsComposition::removeComposerItem(), and QgsComposition::selectedComposerItems().

void QgsComposerView::keyReleaseEvent ( QKeyEvent * e ) [protected]

Definition at line 531 of file qgscomposerview.cpp.

References mShiftKeyPressed.

void QgsComposerView::mouseDoubleClickEvent ( QMouseEvent * e ) [protected]

Definition at line 421 of file qgscomposerview.cpp.

void QgsComposerView::mouseMoveEvent ( QMouseEvent * e ) [protected]

Definition at line 325 of file qgscomposerview.cpp.

References AddArrow, AddEllipse, AddMap, AddRectangle, AddTriangle, composition(), mCurrentTool, mMoveContentItem, mMoveContentStartPos, MoveItemContent, mRubberBandItem, mRubberBandLineItem, mRubberBandStartPos, Select, and QgsComposerMap::setOffset().

void QgsComposerView::mousePressEvent ( QMouseEvent * e ) [protected]

Definition at line 53 of file qgscomposerview.cpp.

References actionFinished(), AddArrow, QgsComposition::addComposerLabel(), QgsComposition::addComposerLegend(), QgsComposition::addComposerPicture(), QgsComposition::addComposerScaleBar(), QgsComposition::addComposerTable(), AddEllipse, AddLabel, AddLegend, AddMap, AddPicture, AddRectangle, AddScalebar, AddTable, AddTriangle, QgsComposerLabel::adjustSizeToText(), QgsComposerScaleBar::applyDefaultSize(), QgsComposition::composerItemAt(), QgsComposition::composerMapItems(), composition(), mCurrentTool, mMoveContentItem, mMoveContentStartPos, MoveItemContent, mRubberBandItem, mRubberBandLineItem, mRubberBandStartPos, mShiftKeyPressed, QgsComposerItem::positionLock(), QgsComposition::pushAddRemoveCommand(), Select, selectedItemChanged(), QgsComposerScaleBar::setComposerMap(), QgsComposerItem::setPositionLock(), QgsComposerPicture::setSceneRect(), QgsComposerAttributeTable::setSceneRect(), QgsComposerItem::setSceneRect(), QgsComposerItem::setSelected(), QgsComposerLabel::setText(), QgsComposition::snapPointToGrid(), QgsComposerItem::updateCursor(), and QgsComposerLegend::updateLegend().

void QgsComposerView::mouseReleaseEvent ( QMouseEvent * e ) [protected]

void QgsComposerView::paintEvent ( QPaintEvent * event ) [protected]

Definition at line 557 of file qgscomposerview.cpp.

References mPaintingEnabled.

bool QgsComposerView::paintingEnabled ( ) const [inline]

Definition at line 89 of file qgscomposerview.h.

void QgsComposerView::selectedItemChanged ( QgsComposerItem * selected ) [signal]

Is emitted when selected item changed.

If 0, no item is selected

Referenced by groupItems(), and mousePressEvent().

void QgsComposerView::setComposition ( QgsComposition * c )

Sets composition (derived from QGraphicsScene)

Definition at line 582 of file qgscomposerview.cpp.

void QgsComposerView::setCurrentTool ( QgsComposerView::Tool t ) [inline]

Definition at line 78 of file qgscomposerview.h.

void QgsComposerView::setPaintingEnabled ( bool enabled ) [inline]

Definition at line 88 of file qgscomposerview.h.

void QgsComposerView::showEvent ( QShowEvent * e ) [protected]

Definition at line 576 of file qgscomposerview.cpp.

References composerViewShow().

void QgsComposerView::ungroupItems ( )

Ungroups the selected items.

Definition at line 625 of file qgscomposerview.cpp.

References composition(), itemRemoved(), QgsComposerItemGroup::removeItems(), and QgsComposition::selectedComposerItems().

void QgsComposerView::wheelEvent ( QWheelEvent * event ) [protected]

Definition at line 539 of file qgscomposerview.cpp.

References QgsComposerItem::beginCommand(), QgsComposition::composerItemAt(), and composition().

Member Data Documentation

QgsComposerView::Tool QgsComposerView::mCurrentTool [private]

Current composer tool.

Definition at line 111 of file qgscomposerview.h.

Referenced by mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

QgsComposerItem* QgsComposerView::mMoveContentItem [private]

Item to move content.

Definition at line 117 of file qgscomposerview.h.

Referenced by mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

QPointF QgsComposerView::mMoveContentStartPos [private]

Start position of content move.

Definition at line 119 of file qgscomposerview.h.

Referenced by mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

bool QgsComposerView::mPaintingEnabled [private]

Definition at line 123 of file qgscomposerview.h.

Referenced by paintEvent().

QGraphicsRectItem* QgsComposerView::mRubberBandItem [private]

Rubber band item.

Definition at line 113 of file qgscomposerview.h.

Referenced by addShape(), mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

QGraphicsLineItem* QgsComposerView::mRubberBandLineItem [private]

Rubber band item for arrows.

Definition at line 115 of file qgscomposerview.h.

Referenced by mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

QPointF QgsComposerView::mRubberBandStartPos [private]

Start of rubber band creation.

Definition at line 121 of file qgscomposerview.h.

Referenced by mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

bool QgsComposerView::mShiftKeyPressed [private]

Status of shift key (used for multiple selection)

Definition at line 109 of file qgscomposerview.h.

Referenced by keyPressEvent(), keyReleaseEvent(), and mousePressEvent().

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

src/gui/qgscomposerview.h
src/gui/qgscomposerview.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation