QgsComposerView Class Reference
[MapComposerQGIS gui library.]

Widget to display the composer items. More...

#include <qgscomposerview.h>

Collaboration diagram for QgsComposerView:

Collaboration graph
[legend]

List of all members.

Public Types

enum  Tool {
  Select = 0, AddArrow, AddMap, AddLegend,
  AddLabel, AddScalebar, AddPicture, AddShape,
  AddTable, MoveItemContent
}
 Current tool. More...

Public Slots

void sendItemRemovedSignal (QgsComposerItem *item)
 For QgsComposerItemGroup to send its signals to QgsComposer (or other classes that keep track of input widgets).

Signals

void selectedItemChanged (const QgsComposerItem *selected)
 Is emitted when selected item changed.
void composerArrowAdded (QgsComposerArrow *arrow)
 Is emitted when new composer arrow has been added to the view.
void composerLabelAdded (QgsComposerLabel *label)
 Is emitted when new composer label has been added to the view.
void composerMapAdded (QgsComposerMap *map)
 Is emitted when new composer map has been added to the view.
void composerScaleBarAdded (QgsComposerScaleBar *scalebar)
 Is emitted when new composer scale bar has been added.
void composerLegendAdded (QgsComposerLegend *legend)
 Is emitted when a new composer legend has been added.
void composerPictureAdded (QgsComposerPicture *picture)
 Is emitted when a new composer picture has been added.
void composerShapeAdded (QgsComposerShape *shape)
 Is emitted when a new composer shape has been added.
void composerTableAdded (QgsComposerAttributeTable *table)
 Is emitted when a new composer table has been added.
void itemRemoved (QgsComposerItem *)
 Is emitted when a composer item has been removed from the scene.
void actionFinished ()
 Current action (e.g.

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).
QgsCompositioncomposition ()
 Returns the composition or 0 in case of error.
void addComposerArrow (QgsComposerArrow *arrow)
 Adds an arrow item to the graphics scene and advices composer to create a widget for it (through signal).
void addComposerLabel (QgsComposerLabel *label)
 Adds label to the graphics scene and advices composer to create a widget for it (through signal).
void addComposerMap (QgsComposerMap *map)
 Adds map to the graphics scene and advices composer to create a widget for it (through signal).
void addComposerScaleBar (QgsComposerScaleBar *scaleBar)
 Adds scale bar to the graphics scene and advices composer to create a widget for it (through signal).
void addComposerLegend (QgsComposerLegend *legend)
 Adds legend to the graphics scene and advices composer to create a widget for it (through signal).
void addComposerPicture (QgsComposerPicture *picture)
 Adds picture to the graphics scene and advices composer to create a widget for it (through signal).
void addComposerShape (QgsComposerShape *shape)
 Adds a composer shape to the graphics scene and advices composer to create a widget for it (through signal).
void addComposerTable (QgsComposerAttributeTable *table)
 Adds a composer table to the graphics scene and advices composer to create a widget for it (through signal).
QMainWindow * composerWindow ()
 Returns the composer main window.

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)

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.
QgsComposerItemmMoveContentItem
 Item to move content.
QPointF mMoveContentStartPos
 Start position of content move.
QPointF mRubberBandStartPos
 Start of rubber band creation.


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 44 of file qgscomposerview.h.


Member Enumeration Documentation

Current tool.

Enumerator:
Select 
AddArrow 
AddMap 
AddLegend 
AddLabel 
AddScalebar 
AddPicture 
AddShape 
AddTable 
MoveItemContent 

Definition at line 51 of file qgscomposerview.h.


Constructor & Destructor Documentation

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

Definition at line 33 of file qgscomposerview.cpp.


Member Function Documentation

void QgsComposerView::groupItems (  ) 

void QgsComposerView::ungroupItems (  ) 

Ungroups the selected items.

Definition at line 580 of file qgscomposerview.cpp.

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

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

Definition at line 73 of file qgscomposerview.h.

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

Definition at line 74 of file qgscomposerview.h.

void QgsComposerView::setComposition ( QgsComposition c  ) 

Sets composition (derived from QGraphicsScene).

Definition at line 453 of file qgscomposerview.cpp.

QgsComposition * QgsComposerView::composition (  ) 

void QgsComposerView::addComposerArrow ( QgsComposerArrow arrow  ) 

Adds an arrow item to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 471 of file qgscomposerview.cpp.

References composerArrowAdded(), composition(), selectedItemChanged(), and QgsComposerItem::setSelected().

Referenced by mouseReleaseEvent().

void QgsComposerView::addComposerLabel ( QgsComposerLabel label  ) 

Adds label to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 480 of file qgscomposerview.cpp.

References composerLabelAdded(), composition(), selectedItemChanged(), and QgsComposerItem::setSelected().

Referenced by mousePressEvent().

void QgsComposerView::addComposerMap ( QgsComposerMap map  ) 

Adds map to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 489 of file qgscomposerview.cpp.

References QgsComposerMap::cache(), QgsComposerMap::Cache, composerMapAdded(), selectedItemChanged(), QgsComposerMap::setPreviewMode(), and QgsComposerItem::setSelected().

Referenced by mouseReleaseEvent().

void QgsComposerView::addComposerScaleBar ( QgsComposerScaleBar scaleBar  ) 

Adds scale bar to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 501 of file qgscomposerview.cpp.

References QgsComposerScaleBar::applyDefaultSettings(), QgsComposition::composerMapItems(), composerScaleBarAdded(), composition(), selectedItemChanged(), QgsComposerScaleBar::setComposerMap(), and QgsComposerItem::setSelected().

Referenced by mousePressEvent().

void QgsComposerView::addComposerLegend ( QgsComposerLegend legend  ) 

Adds legend to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 517 of file qgscomposerview.cpp.

References composerLegendAdded(), selectedItemChanged(), and QgsComposerItem::setSelected().

Referenced by mousePressEvent().

void QgsComposerView::addComposerPicture ( QgsComposerPicture picture  ) 

Adds picture to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 526 of file qgscomposerview.cpp.

References composerPictureAdded(), selectedItemChanged(), and QgsComposerItem::setSelected().

Referenced by mousePressEvent().

void QgsComposerView::addComposerShape ( QgsComposerShape shape  ) 

Adds a composer shape to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 535 of file qgscomposerview.cpp.

References composerShapeAdded(), selectedItemChanged(), and QgsComposerItem::setSelected().

Referenced by mouseReleaseEvent().

void QgsComposerView::addComposerTable ( QgsComposerAttributeTable table  ) 

Adds a composer table to the graphics scene and advices composer to create a widget for it (through signal).

Definition at line 544 of file qgscomposerview.cpp.

References composerTableAdded(), selectedItemChanged(), and QgsComposerItem::setSelected().

Referenced by mousePressEvent().

QMainWindow * QgsComposerView::composerWindow (  ) 

Returns the composer main window.

Definition at line 608 of file qgscomposerview.cpp.

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

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

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

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

Definition at line 365 of file qgscomposerview.cpp.

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

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

Definition at line 429 of file qgscomposerview.cpp.

References mShiftKeyPressed.

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

void QgsComposerView::sendItemRemovedSignal ( QgsComposerItem item  )  [slot]

For QgsComposerItemGroup to send its signals to QgsComposer (or other classes that keep track of input widgets).

Definition at line 603 of file qgscomposerview.cpp.

References itemRemoved().

Referenced by groupItems().

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

void QgsComposerView::composerArrowAdded ( QgsComposerArrow arrow  )  [signal]

Is emitted when new composer arrow has been added to the view.

Referenced by addComposerArrow().

void QgsComposerView::composerLabelAdded ( QgsComposerLabel label  )  [signal]

Is emitted when new composer label has been added to the view.

Referenced by addComposerLabel().

void QgsComposerView::composerMapAdded ( QgsComposerMap map  )  [signal]

Is emitted when new composer map has been added to the view.

Referenced by addComposerMap().

void QgsComposerView::composerScaleBarAdded ( QgsComposerScaleBar scalebar  )  [signal]

Is emitted when new composer scale bar has been added.

Referenced by addComposerScaleBar().

void QgsComposerView::composerLegendAdded ( QgsComposerLegend legend  )  [signal]

Is emitted when a new composer legend has been added.

Referenced by addComposerLegend().

void QgsComposerView::composerPictureAdded ( QgsComposerPicture picture  )  [signal]

Is emitted when a new composer picture has been added.

Referenced by addComposerPicture().

void QgsComposerView::composerShapeAdded ( QgsComposerShape shape  )  [signal]

Is emitted when a new composer shape has been added.

Referenced by addComposerShape().

void QgsComposerView::composerTableAdded ( QgsComposerAttributeTable table  )  [signal]

Is emitted when a new composer table has been added.

Referenced by addComposerTable().

void QgsComposerView::itemRemoved ( QgsComposerItem  )  [signal]

Is emitted when a composer item has been removed from the scene.

Referenced by keyPressEvent(), sendItemRemovedSignal(), and ungroupItems().

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 mousePressEvent(), and mouseReleaseEvent().


Member Data Documentation

Status of shift key (used for multiple selection).

Definition at line 114 of file qgscomposerview.h.

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

Current composer tool.

Definition at line 116 of file qgscomposerview.h.

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

QGraphicsRectItem* QgsComposerView::mRubberBandItem [private]

Rubber band item.

Definition at line 118 of file qgscomposerview.h.

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

QGraphicsLineItem* QgsComposerView::mRubberBandLineItem [private]

Rubber band item for arrows.

Definition at line 120 of file qgscomposerview.h.

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

Item to move content.

Definition at line 122 of file qgscomposerview.h.

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

Start position of content move.

Definition at line 124 of file qgscomposerview.h.

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

Start of rubber band creation.

Definition at line 126 of file qgscomposerview.h.

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


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

Generated on Sat Feb 4 19:17:30 2012 for Quantum GIS API Documentation by  doxygen 1.5.6