QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Enumerations
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  QgsLegendModelV2
 Item model implementation based on layer tree model for composer legend. More...
 
class  QgsComposerLegend
 A legend that can be placed onto a map composition. More...
 
class  QgsComposerLegendStyle
 Composer legend components style. More...
 
class  QgsComposerMouseHandles
 Handles drawing of selection outlines and mouse handles. More...
 
class  QgsComposerObject
 A base class for objects which belong to a map composition. 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  QgsComposerUtils
 Utilities for compositions. 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...
 
class  QgsComposerMapGridStack
 A collection of grids which is drawn above the map content in a QgsComposerMap. More...
 
class  QgsComposerMapGrid
 An individual grid which is drawn above the map content in a QgsComposerMap. More...
 
class  QgsComposerMapItem
 An item which is drawn inside a QgsComposerMap, eg a grid or map overview. More...
 
class  QgsComposerMapItemStack
 A collection of map items which are drawn above the map content in a QgsComposerMap. More...
 
class  QgsComposerMapOverviewStack
 A collection of overviews which are drawn above the map content in a QgsComposerMap. More...
 
class  QgsComposerMapOverview
 An individual overview which is drawn above the map content in a QgsComposerMap, and shows the extent of another QgsComposerMap. More...
 
class  QgsComposerModel
 A model for items attached to a composition. 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  QgsComposerItem::ZoomMode { QgsComposerItem::Zoom = 0, QgsComposerItem::ZoomRecenter, QgsComposerItem::ZoomToPoint, QgsComposerItem::NoZoom }
 Modes for zooming item content. More...
 
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  QgsComposerObject::DataDefinedProperty {
  QgsComposerObject::NoProperty = 0, QgsComposerObject::AllProperties, QgsComposerObject::TestProperty, QgsComposerObject::PresetPaperSize,
  QgsComposerObject::PaperWidth, QgsComposerObject::PaperHeight, QgsComposerObject::NumPages, QgsComposerObject::PaperOrientation,
  QgsComposerObject::PageNumber, QgsComposerObject::PositionX, QgsComposerObject::PositionY, QgsComposerObject::ItemWidth,
  QgsComposerObject::ItemHeight, QgsComposerObject::ItemRotation, QgsComposerObject::Transparency, QgsComposerObject::BlendMode,
  QgsComposerObject::ExcludeFromExports, QgsComposerObject::MapRotation, QgsComposerObject::MapScale, QgsComposerObject::MapXMin,
  QgsComposerObject::MapYMin, QgsComposerObject::MapXMax, QgsComposerObject::MapYMax, QgsComposerObject::MapAtlasMargin,
  QgsComposerObject::PictureSource, QgsComposerObject::SourceUrl
}
 Data defined properties for different item types. More...
 
enum  QgsComposerObject::PropertyValueType { QgsComposerObject::EvaluatedValue = 0, QgsComposerObject::OriginalValue }
 Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
 
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 }
 
enum  QgsComposerScaleBar::ScaleBarUnits { QgsComposerScaleBar::MapUnits = 0, QgsComposerScaleBar::Meters, QgsComposerScaleBar::Feet, QgsComposerScaleBar::NauticalMiles }
 
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::PaperOrientation { QgsComposition::Portrait, QgsComposition::Landscape }
 
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 }
 
enum  QgsComposerView::Tool {
  QgsComposerView::Select = 0, QgsComposerView::AddArrow, QgsComposerView::AddHtml, QgsComposerView::AddMap,
  QgsComposerView::AddLegend, QgsComposerView::AddLabel, QgsComposerView::AddScalebar, QgsComposerView::AddPicture,
  QgsComposerView::AddRectangle, QgsComposerView::AddEllipse, QgsComposerView::AddTriangle, QgsComposerView::AddTable,
  QgsComposerView::AddAttributeTable, QgsComposerView::MoveItemContent, QgsComposerView::Pan, QgsComposerView::Zoom
}
 Current tool. More...
 
enum  QgsComposerView::ClipboardMode { QgsComposerView::ClipboardModeCut, QgsComposerView::ClipboardModeCopy }
 
enum  QgsComposerView::PasteMode { QgsComposerView::PasteModeCursor, QgsComposerView::PasteModeCenter, QgsComposerView::PasteModeInPlace }
 
enum  QgsComposerView::ToolStatus { QgsComposerView::Inactive, QgsComposerView::Active, QgsComposerView::ActiveUntilMouseRelease }
 

Detailed Description

Enumeration Type Documentation

Enumerator
Left 
Middle 
Right 

Composition atlas modes.

Enumerator
AtlasOff 
PreviewAtlas 
ExportAtlas 
Enumerator
ClipboardModeCut 
ClipboardModeCopy 

Data defined properties for different item types.

Enumerator
NoProperty 
AllProperties 
TestProperty 
PresetPaperSize 
PaperWidth 
PaperHeight 
NumPages 
PaperOrientation 
PageNumber 
PositionX 
PositionY 
ItemWidth 
ItemHeight 
ItemRotation 
Transparency 
BlendMode 
ExcludeFromExports 
MapRotation 
MapScale 
MapXMin 
MapYMin 
MapXMax 
MapYMax 
MapAtlasMargin 
PictureSource 
SourceUrl 

Style to draw the snapping grid.

Enumerator
Solid 
Dots 
Crosses 
Enumerator
UpperLeft 
UpperMiddle 
UpperRight 
MiddleLeft 
Middle 
MiddleRight 
LowerLeft 
LowerMiddle 
LowerRight 
Enumerator
UpperLeft 
UpperMiddle 
UpperRight 
MiddleLeft 
Middle 
MiddleRight 
LowerLeft 
LowerMiddle 
LowerRight 
Enumerator
ComposerItem 
ComposerArrow 
ComposerItemGroup 
ComposerLabel 
ComposerLegend 
ComposerMap 
ComposerPaper 
ComposerPicture 
ComposerScaleBar 
ComposerShape 
ComposerTable 
ComposerAttributeTable 
ComposerTextTable 
ComposerFrame 
Enumerator
GroupItem 
LayerItem 
ClassificationItem 

Format of source image

Enumerator
SVG 
RASTER 
Unknown 

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 

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 
Enumerator
Portrait 
Landscape 
Enumerator
PasteModeCursor 
PasteModeCenter 
PasteModeInPlace 

Plot type.

Enumerator
Preview 
Print 
Postscript 

Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property.

This may differ if a property has a data defined expression active.

Enumerator
EvaluatedValue 
OriginalValue 

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

Enumerator
MapUnits 
Meters 
Feet 
NauticalMiles 
Enumerator
Top 
Bottom 
Left 
Right 
Enumerator
Item 
Point 
Enumerator
Undefined 
Hidden 
Title 
Group 
Subgroup 
Symbol 
SymbolLabel 
Enumerator
TicksUp 
TicksDown 
TicksMiddle 

Current tool.

Enumerator
Select 
AddArrow 
AddHtml 
AddMap 
AddLegend 
AddLabel 
AddScalebar 
AddPicture 
AddRectangle 
AddEllipse 
AddTriangle 
AddTable 
AddAttributeTable 
MoveItemContent 
Pan 
Zoom 
Enumerator
Inactive 
Active 
ActiveUntilMouseRelease 

Modes for zooming item content.

Enumerator
Zoom 
ZoomRecenter 
ZoomToPoint 
NoZoom 
Enumerator
ZValueBelow 
ZValueAbove