MapComposer

Collaboration diagram for MapComposer:

Classes
class	QgsAtlasComposition
	Class used to render an Atlas, iterating over geometry features. More...
class	QgsComposerItem
	A item that forms part of a map composition. More...
class	QgsComposerItemGroup
	A container for grouping several QgsComposerItems. More...
class	QgsComposerLabel
	A label that can be placed onto a map composition. More...
class	QgsComposerLegend
	A legend that can be placed onto a map composition. More...
class	QgsComposerLegend::Nucleon
	Nucleon is either group title, layer title or layer child item. More...
class	QgsComposerLegend::Atom
	Atom is indivisible set (indivisible into more columns). More...
class	QgsComposerLegendStyle
	Composer legend components style. More...
class	QgsComposerMouseHandles
	Handles drawing of selection outlines and mouse handles. More...
class	QgsComposerPicture
	A composer class that displays svg files or raster format (jpg, png, ...) More...
class	QgsComposerScaleBar
	A scale bar item that can be added to a map composition. More...
class	QgsComposition
	Graphics scene for map printing. More...
class	QgsDoubleBoxScaleBarStyle
	Double box with alternating colors. More...
class	QgsLegendModel
	A model that provides group, layer and classification items. More...
class	QgsNumericScaleBarStyle
	A scale bar style that draws text in the form of '1:XXXXX'. More...
class	QgsScaleBarStyle
	Abstraction of composer scale bar style. More...
class	QgsSingleBoxScaleBarStyle
	Scalebar style that draws a single box with alternating color for the segments. More...
class	QgsTicksScaleBarStyle
	A scale bar that draws segments using short ticks. More...
class	QgsComposerView
	Widget to display the composer items. More...
class	QgsComposerMap
	Object representing map window. More...

Enumerations
enum	QgsComposerItem::ItemType {   QgsComposerItem::ComposerItem = UserType + 100, QgsComposerItem::ComposerArrow, QgsComposerItem::ComposerItemGroup, QgsComposerItem::ComposerLabel,   QgsComposerItem::ComposerLegend, QgsComposerItem::ComposerMap, QgsComposerItem::ComposerPaper, QgsComposerItem::ComposerPicture,   QgsComposerItem::ComposerScaleBar, QgsComposerItem::ComposerShape, QgsComposerItem::ComposerTable, QgsComposerItem::ComposerAttributeTable,   QgsComposerItem::ComposerTextTable, QgsComposerItem::ComposerFrame }
enum	QgsComposerItem::MouseMoveAction {   QgsComposerItem::MoveItem, QgsComposerItem::ResizeUp, QgsComposerItem::ResizeDown, QgsComposerItem::ResizeLeft,   QgsComposerItem::ResizeRight, QgsComposerItem::ResizeLeftUp, QgsComposerItem::ResizeRightUp, QgsComposerItem::ResizeLeftDown,   QgsComposerItem::ResizeRightDown, QgsComposerItem::NoAction }
	Describes the action (move or resize in different directon) to be done during mouse move. More...
enum	QgsComposerItem::ItemPositionMode {   QgsComposerItem::UpperLeft, QgsComposerItem::UpperMiddle, QgsComposerItem::UpperRight, QgsComposerItem::MiddleLeft,   QgsComposerItem::Middle, QgsComposerItem::MiddleRight, QgsComposerItem::LowerLeft, QgsComposerItem::LowerMiddle,   QgsComposerItem::LowerRight }
enum	QgsComposerLegendStyle::Style {   QgsComposerLegendStyle::Undefined, QgsComposerLegendStyle::Hidden, QgsComposerLegendStyle::Title, QgsComposerLegendStyle::Group,   QgsComposerLegendStyle::Subgroup, QgsComposerLegendStyle::Symbol, QgsComposerLegendStyle::SymbolLabel }
enum	QgsComposerLegendStyle::Side { QgsComposerLegendStyle::Top = 0, QgsComposerLegendStyle::Bottom = 1, QgsComposerLegendStyle::Left = 2, QgsComposerLegendStyle::Right = 3 }
enum	QgsComposerMouseHandles::MouseAction {   QgsComposerMouseHandles::MoveItem, QgsComposerMouseHandles::ResizeUp, QgsComposerMouseHandles::ResizeDown, QgsComposerMouseHandles::ResizeLeft,   QgsComposerMouseHandles::ResizeRight, QgsComposerMouseHandles::ResizeLeftUp, QgsComposerMouseHandles::ResizeRightUp, QgsComposerMouseHandles::ResizeLeftDown,   QgsComposerMouseHandles::ResizeRightDown, QgsComposerMouseHandles::SelectItem, QgsComposerMouseHandles::NoAction }
	Describes the action (move or resize in different directon) to be done during mouse move. More...
enum	QgsComposerMouseHandles::ItemPositionMode {   QgsComposerMouseHandles::UpperLeft, QgsComposerMouseHandles::UpperMiddle, QgsComposerMouseHandles::UpperRight, QgsComposerMouseHandles::MiddleLeft,   QgsComposerMouseHandles::Middle, QgsComposerMouseHandles::MiddleRight, QgsComposerMouseHandles::LowerLeft, QgsComposerMouseHandles::LowerMiddle,   QgsComposerMouseHandles::LowerRight }
enum	QgsComposerMouseHandles::SnapGuideMode { QgsComposerMouseHandles::Item, QgsComposerMouseHandles::Point }
enum	QgsComposerPicture::ResizeMode {   QgsComposerPicture::Zoom, QgsComposerPicture::Stretch, QgsComposerPicture::Clip, QgsComposerPicture::ZoomResizeFrame,   QgsComposerPicture::FrameToImageSize }
enum	QgsComposerPicture::Mode { QgsComposerPicture::SVG, QgsComposerPicture::RASTER, QgsComposerPicture::Unknown }
enum	QgsComposerScaleBar::Alignment { QgsComposerScaleBar::Left = 0, QgsComposerScaleBar::Middle, QgsComposerScaleBar::Right }
	Added in version 1.8. More...
enum	QgsComposerScaleBar::ScaleBarUnits { QgsComposerScaleBar::MapUnits = 0, QgsComposerScaleBar::Meters, QgsComposerScaleBar::Feet, QgsComposerScaleBar::NauticalMiles }
	Added in version 1.9. More...
enum	QgsComposition::PlotStyle { QgsComposition::Preview = 0, QgsComposition::Print, QgsComposition::Postscript }
	Plot type. More...
enum	QgsComposition::GridStyle { QgsComposition::Solid, QgsComposition::Dots, QgsComposition::Crosses }
	Style to draw the snapping grid. More...
enum	QgsComposition::ZValueDirection { QgsComposition::ZValueBelow, QgsComposition::ZValueAbove }
enum	QgsComposition::AtlasMode { QgsComposition::AtlasOff, QgsComposition::PreviewAtlas, QgsComposition::ExportAtlas }
	Composition atlas modes. More...
enum	QgsLegendModel::ItemType { QgsLegendModel::GroupItem = 0, QgsLegendModel::LayerItem, QgsLegendModel::ClassificationItem }
enum	QgsTicksScaleBarStyle::TickPosition { QgsTicksScaleBarStyle::TicksUp, QgsTicksScaleBarStyle::TicksDown, QgsTicksScaleBarStyle::TicksMiddle }

Detailed Description

Enumeration Type Documentation

enum QgsComposerScaleBar::Alignment

Added in version 1.8.

Enumerator
Left
Middle
Right

Definition at line 37 of file qgscomposerscalebar.h.

enum QgsComposition::AtlasMode

Composition atlas modes.

Enumerator
AtlasOff
PreviewAtlas
ExportAtlas

Definition at line 98 of file qgscomposition.h.

enum QgsComposition::GridStyle

Style to draw the snapping grid.

Enumerator
Solid
Dots
Crosses

Definition at line 80 of file qgscomposition.h.

enum QgsComposerMouseHandles::ItemPositionMode

Enumerator
UpperLeft
UpperMiddle
UpperRight
MiddleLeft
Middle
MiddleRight
LowerLeft
LowerMiddle
LowerRight

Definition at line 52 of file qgscomposermousehandles.h.

enum QgsComposerItem::ItemPositionMode

Enumerator
UpperLeft
UpperMiddle
UpperRight
MiddleLeft
Middle
MiddleRight
LowerLeft
LowerMiddle
LowerRight

Definition at line 77 of file qgscomposeritem.h.

enum QgsComposerItem::ItemType

Enumerator
ComposerItem
ComposerArrow
ComposerItemGroup
ComposerLabel
ComposerLegend
ComposerMap
ComposerPaper
ComposerPicture
ComposerScaleBar
ComposerShape
ComposerTable
ComposerAttributeTable
ComposerTextTable
ComposerFrame

Definition at line 41 of file qgscomposeritem.h.

enum QgsLegendModel::ItemType

Enumerator
GroupItem
LayerItem
ClassificationItem

Definition at line 45 of file qgslegendmodel.h.

enum QgsComposerPicture::Mode

Format of source image

Enumerator
SVG
RASTER
Unknown

Definition at line 49 of file qgscomposerpicture.h.

enum QgsComposerMouseHandles::MouseAction

Describes the action (move or resize in different directon) to be done during mouse move.

Enumerator
MoveItem
ResizeUp
ResizeDown
ResizeLeft
ResizeRight
ResizeLeftUp
ResizeRightUp
ResizeLeftDown
ResizeRightDown
SelectItem
NoAction

Definition at line 37 of file qgscomposermousehandles.h.

enum QgsComposerItem::MouseMoveAction

Describes the action (move or resize in different directon) to be done during mouse move.

Enumerator
MoveItem
ResizeUp
ResizeDown
ResizeLeft
ResizeRight
ResizeLeftUp
ResizeRightUp
ResizeLeftDown
ResizeRightDown
NoAction

Definition at line 63 of file qgscomposeritem.h.

enum QgsComposition::PlotStyle

Plot type.

Enumerator
Preview
Print
Postscript

Definition at line 72 of file qgscomposition.h.

enum QgsComposerPicture::ResizeMode

Controls how pictures are scaled within the item's frame

Enumerator
Zoom	enlarges image to fit frame while maintaining aspect ratio of picture
Stretch	stretches image to fit frame, ignores aspect ratio
Clip	draws image at original size and clips any portion which falls outside frame
ZoomResizeFrame	enlarges image to fit frame, then resizes frame to fit resultant image
FrameToImageSize	sets size of frame to match original size of image without scaling

Definition at line 38 of file qgscomposerpicture.h.

enum QgsComposerScaleBar::ScaleBarUnits

Added in version 1.9.

Enumerator
MapUnits
Meters
Feet
NauticalMiles

Definition at line 45 of file qgscomposerscalebar.h.

enum QgsComposerLegendStyle::Side

Enumerator
Top
Bottom
Left
Right

Definition at line 43 of file qgscomposerlegendstyle.h.

enum QgsComposerMouseHandles::SnapGuideMode

Enumerator
Item
Point

Definition at line 65 of file qgscomposermousehandles.h.

enum QgsComposerLegendStyle::Style

Enumerator
Undefined
Hidden
Title
Group
Subgroup
Symbol
SymbolLabel

Definition at line 33 of file qgscomposerlegendstyle.h.

enum QgsTicksScaleBarStyle::TickPosition

Enumerator
TicksUp
TicksDown
TicksMiddle

Definition at line 28 of file qgsticksscalebarstyle.h.

enum QgsComposition::ZValueDirection

Enumerator
ZValueBelow
ZValueAbove

Definition at line 87 of file qgscomposition.h.