/usr/include/qgis/qgscomposition.h is in libqgis-dev 1.7.4+1.7.5~20120320-1.1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | /***************************************************************************
qgscomposition.h
-------------------
begin : January 2005
copyright : (C) 2005 by Radim Blazek
email : blazek@itc.it
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSCOMPOSITION_H
#define QGSCOMPOSITION_H
#include <QDomDocument>
#include <QGraphicsScene>
#include <QLinkedList>
#include <QUndoStack>
#include "qgscomposeritemcommand.h"
class QgsComposerItem;
class QgsComposerMap;
class QgsPaperItem;
class QGraphicsRectItem;
class QgsMapRenderer;
class QDomElement;
/** \ingroup MapComposer
* Graphics scene for map printing. The class manages the paper item which always
* is the item in the back (z-value 0). It maintains the z-Values of the items and stores
* them in a list in ascending z-Order. This list can be changed to lower/raise items one position
* or to bring them to front/back.
* */
class CORE_EXPORT QgsComposition: public QGraphicsScene
{
Q_OBJECT
public:
/** \brief Plot type */
enum PlotStyle
{
Preview = 0, // Use cache etc
Print, // Render well
Postscript // Fonts need different scaling!
};
/**Style to draw the snapping grid*/
enum GridStyle
{
Solid,
Dots,
Crosses
};
QgsComposition( QgsMapRenderer* mapRenderer );
~QgsComposition();
/**Changes size of paper item*/
void setPaperSize( double width, double height );
/**Returns height of paper item*/
double paperHeight() const;
/**Returns width of paper item*/
double paperWidth() const;
void setSnapToGridEnabled( bool b );
bool snapToGridEnabled() const {return mSnapToGrid;}
void setSnapGridResolution( double r );
double snapGridResolution() const {return mSnapGridResolution;}
void setSnapGridOffsetX( double offset );
double snapGridOffsetX() const {return mSnapGridOffsetX;}
void setSnapGridOffsetY( double offset );
double snapGridOffsetY() const {return mSnapGridOffsetY;}
void setGridPen( const QPen& p );
const QPen& gridPen() const {return mGridPen;}
void setGridStyle( GridStyle s );
GridStyle gridStyle() const {return mGridStyle;}
/**Returns pointer to undo/redo command storage*/
QUndoStack* undoStack() { return &mUndoStack; }
/**Returns the topmost composer item. Ignores mPaperItem*/
QgsComposerItem* composerItemAt( const QPointF & position );
QList<QgsComposerItem*> selectedComposerItems();
/**Returns pointers to all composer maps in the scene*/
QList<const QgsComposerMap*> composerMapItems() const;
/**Returns the composer map with specified id
@return id or 0 pointer if the composer map item does not exist*/
const QgsComposerMap* getComposerMapById( int id ) const;
int printResolution() const {return mPrintResolution;}
void setPrintResolution( int dpi ) {mPrintResolution = dpi;}
bool printAsRaster() const {return mPrintAsRaster;}
void setPrintAsRaster( bool enabled ) { mPrintAsRaster = enabled; }
/**Returns pointer to map renderer of qgis map canvas*/
QgsMapRenderer* mapRenderer() {return mMapRenderer;}
QgsComposition::PlotStyle plotStyle() const {return mPlotStyle;}
void setPlotStyle( QgsComposition::PlotStyle style ) {mPlotStyle = style;}
/**Returns the pixel font size for a font that has point size set.
The result depends on the resolution (dpi) and of the preview mode. Each item that sets
a font should call this function before drawing text*/
int pixelFontSize( double pointSize ) const;
/**Does the inverse calculation and returns points for pixels (equals to mm in QgsComposition)*/
double pointFontSize( int pixelSize ) const;
/**Writes settings to xml (paper dimension)*/
bool writeXML( QDomElement& composerElem, QDomDocument& doc );
/**Reads settings from xml file*/
bool readXML( const QDomElement& compositionElem, const QDomDocument& doc );
/**Adds item to z list. Usually called from constructor of QgsComposerItem*/
void addItemToZList( QgsComposerItem* item );
/**Removes item from z list. Usually called from destructor of QgsComposerItem*/
void removeItemFromZList( QgsComposerItem* item );
//functions to move selected items in hierarchy
void raiseSelectedItems();
void raiseItem( QgsComposerItem* item );
void lowerSelectedItems();
void lowerItem( QgsComposerItem* item );
void moveSelectedItemsToTop();
void moveItemToTop( QgsComposerItem* item );
void moveSelectedItemsToBottom();
void moveItemToBottom( QgsComposerItem* item );
//functions to align selected items
void alignSelectedItemsLeft();
void alignSelectedItemsHCenter();
void alignSelectedItemsRight();
void alignSelectedItemsTop();
void alignSelectedItemsVCenter();
void alignSelectedItemsBottom();
/**Sorts the zList. The only time where this function needs to be called is from QgsComposer
after reading all the items from xml file*/
void sortZList();
/**Snaps a scene coordinate point to grid*/
QPointF snapPointToGrid( const QPointF& scenePoint ) const;
/**Allocates new item command and saves initial state in it
@param item target item
@param commandText descriptive command text
@param c context for merge commands (unknown for non-mergeable commands)*/
void beginCommand( QgsComposerItem* item, const QString& commandText, QgsComposerMergeCommand::Context c = QgsComposerMergeCommand::Unknown );
/**Saves end state of item and pushes command to the undo history*/
void endCommand();
/**Deletes current command*/
void cancelCommand();
private:
/**Pointer to map renderer of QGIS main map*/
QgsMapRenderer* mMapRenderer;
QgsComposition::PlotStyle mPlotStyle;
QgsPaperItem* mPaperItem;
/**Maintains z-Order of items. Starts with item at position 1 (position 0 is always paper item)*/
QLinkedList<QgsComposerItem*> mItemZList;
/**Dpi for printout*/
int mPrintResolution;
/**Flag if map should be printed as a raster (via QImage). False by default*/
bool mPrintAsRaster;
/**Parameters for snap to grid function*/
bool mSnapToGrid;
double mSnapGridResolution;
double mSnapGridOffsetX;
double mSnapGridOffsetY;
QPen mGridPen;
GridStyle mGridStyle;
QUndoStack mUndoStack;
QgsComposerItemCommand* mActiveCommand;
QgsComposition(); //default constructor is forbidden
/**Reset z-values of items based on position in z list*/
void updateZValues();
/**Returns the bounding rectangle of the selected items in scene coordinates
@return 0 in case of success*/
int boundingRectOfSelectedItems( QRectF& bRect );
void loadGridAppearanceSettings();
void saveGridAppearanceSettings();
signals:
void paperSizeChanged();
};
#endif
|