QgsComposerView Class Reference
[MapComposerGui]

#include <qgscomposerview.h>

Collaboration diagram for QgsComposerView:

Collaboration graph
[legend]
List of all members.

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

Public Types

enum  Tool {
  Select = 0, AddMap, AddLegend, AddLabel,
  AddScalebar, AddPicture, 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 composerLabelAdded (QgsComposerLabel *label)
 Ist emittted 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 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.

Protected Member Functions

void mousePressEvent (QMouseEvent *)
void mouseReleaseEvent (QMouseEvent *)
void mouseMoveEvent (QMouseEvent *)
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.
QgsComposerItemmMoveContentItem
 Item to move content.
QPointF mMoveContentStartPos
 Start position of content move.


Member Enumeration Documentation

enum QgsComposerView::Tool

Current tool.

Enumerator:
Select 
AddMap 
AddLegend 
AddLabel 
AddScalebar 
AddPicture 
MoveItemContent 

Definition at line 47 of file qgscomposerview.h.


Constructor & Destructor Documentation

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

Definition at line 29 of file qgscomposerview.cpp.


Member Function Documentation

void QgsComposerView::groupItems (  ) 

Add an item group containing the selected items.

Definition at line 373 of file qgscomposerview.cpp.

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

void QgsComposerView::ungroupItems (  ) 

Ungroups the selected items.

Definition at line 400 of file qgscomposerview.cpp.

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

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

Definition at line 66 of file qgscomposerview.h.

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

Definition at line 67 of file qgscomposerview.h.

void QgsComposerView::setComposition ( QgsComposition c  ) 

Sets composition (derived from QGraphicsScene).

Definition at line 355 of file qgscomposerview.cpp.

QgsComposition * QgsComposerView::composition (  ) 

Returns the composition or 0 in case of error.

Definition at line 360 of file qgscomposerview.cpp.

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

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

Definition at line 37 of file qgscomposerview.cpp.

References actionFinished(), AddLabel, AddLegend, AddMap, AddPicture, AddScalebar, QgsComposerLabel::adjustSizeToText(), QgsComposerScaleBar::applyDefaultSettings(), QgsComposition::composerItemAt(), composerLabelAdded(), composerLegendAdded(), QgsComposition::composerMapItems(), composerPictureAdded(), composerScaleBarAdded(), composition(), mCurrentTool, mMoveContentItem, mMoveContentStartPos, MoveItemContent, mRubberBandItem, mShiftKeyPressed, Select, selectedItemChanged(), QgsComposerScaleBar::setComposerMap(), QgsComposerPicture::setSceneRect(), QgsComposerItem::setSceneRect(), QgsComposerItem::setSelected(), and QgsComposerLabel::setText().

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

Definition at line 160 of file qgscomposerview.cpp.

References actionFinished(), AddMap, composerMapAdded(), composition(), mCurrentTool, mMoveContentItem, mMoveContentStartPos, QgsComposerItem::moveContent(), MoveItemContent, mRubberBandItem, QgsComposerMap::Rectangle, Select, selectedItemChanged(), QgsComposerMap::setOffset(), QgsComposerMap::setPreviewMode(), and QgsComposerItem::setSelected().

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

Definition at line 226 of file qgscomposerview.cpp.

References AddMap, composition(), mCurrentTool, mMoveContentItem, mMoveContentStartPos, MoveItemContent, mRubberBandItem, Select, and QgsComposerMap::setOffset().

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

Definition at line 275 of file qgscomposerview.cpp.

References composition(), itemRemoved(), mShiftKeyPressed, and QgsComposition::selectedComposerItems().

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

Definition at line 331 of file qgscomposerview.cpp.

References mShiftKeyPressed.

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

Definition at line 339 of file qgscomposerview.cpp.

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

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 423 of file qgscomposerview.cpp.

References itemRemoved().

Referenced by groupItems().

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

Is emitted when selected item changed.

If 0, no item is selected

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

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

Ist emittted when new composer label has been added to the view.

Referenced by mousePressEvent().

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

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

Referenced by mouseReleaseEvent().

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

Is emitted when new composer scale bar has been added.

Referenced by mousePressEvent().

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

Is emitted when a new composer legend has been added.

Referenced by mousePressEvent().

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

Is emitted when a new composer picture has been added.

Referenced by mousePressEvent().

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

bool QgsComposerView::mShiftKeyPressed [private]

Status of shift key (used for multiple selection).

Definition at line 86 of file qgscomposerview.h.

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

QgsComposerView::Tool QgsComposerView::mCurrentTool [private]

Current composer tool.

Definition at line 88 of file qgscomposerview.h.

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

QGraphicsRectItem* QgsComposerView::mRubberBandItem [private]

Rubber band item.

Definition at line 90 of file qgscomposerview.h.

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

QgsComposerItem* QgsComposerView::mMoveContentItem [private]

Item to move content.

Definition at line 92 of file qgscomposerview.h.

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

QPointF QgsComposerView::mMoveContentStartPos [private]

Start position of content move.

Definition at line 94 of file qgscomposerview.h.

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


The documentation for this class was generated from the following files:
Generated on Wed Jan 7 01:51:24 2009 for Quantum GIS API Documentation by  doxygen 1.5.1