sip update

Author: jef-n

python/core/composer/qgscomposerattributetablemodel.sip

@@ -40,7 +40,7 @@ class QgsComposerAttributeTableColumnModel: QAbstractTableModel
      * @param direction direction to move the attribute table column
      * @note added in 2.3
      */
-    bool moveRow( int row , ShiftDirection direction );
+    bool moveRow( int row, ShiftDirection direction );
 
     /**Resets the attribute table's columns to match the source layer's fields. Remove all existing
      * attribute table columns and column customisations.

python/core/composer/qgscomposerattributetablemodelv2.sip

@@ -15,7 +15,6 @@ class QgsComposerAttributeTableColumnModelV2: QAbstractTableModel
       ShiftDown /*!< shift the row/column down */
     };
 
-    /**Constructor for QgsComposerAttributeTableColumnModel.
     /**Constructor for QgsComposerAttributeTableColumnModel.
      * @param composerTable QgsComposerAttributeTable the model is attached to
      * @param parent optional parent
@@ -41,7 +40,7 @@ class QgsComposerAttributeTableColumnModelV2: QAbstractTableModel
      * @param direction direction to move the attribute table column
      * @note added in 2.3
      */
-    bool moveRow( int row , ShiftDirection direction );
+    bool moveRow( int row, ShiftDirection direction );
 
     /**Resets the attribute table's columns to match the source layer's fields. Remove all existing
      * attribute table columns and column customisations.

python/core/composer/qgscomposerattributetablev2.sip

@@ -7,9 +7,7 @@ class QgsComposerAttributeTableCompareV2
 %End
 
   public:
-
     QgsComposerAttributeTableCompareV2();
-
     bool operator()( const QgsComposerTableRow& m1, const QgsComposerTableRow& m2 );
 
     /**Sets column number to sort by
@@ -24,6 +22,7 @@ class QgsComposerAttributeTableCompareV2
 
 };
 
+
 /**A table that displays attributes from a vector layer*/
 class QgsComposerAttributeTableV2 : QgsComposerTableV2
 {
@@ -50,13 +49,15 @@ class QgsComposerAttributeTableV2 : QgsComposerTableV2
     /**Writes properties specific to attribute tables
      * @param elem an existing QDomElement in which to store the attribute table's properties.
      * @param doc QDomDocument for the destination xml.
+     * @param ignoreFrames ignore frames
      * @see readXML
      */
     virtual bool writeXML( QDomElement& elem, QDomDocument & doc, bool ignoreFrames = false ) const;
 
     /**Reads the properties specific to an attribute table from xml.
      * @param itemElem a QDomElement holding the attribute table's desired properties.
      * @param doc QDomDocument for the source xml.
+     * @param ignoreFrames ignore frames
      * @see writeXML
      */
     virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc, bool ignoreFrames = false );
@@ -248,7 +249,7 @@ class QgsComposerAttributeTableV2 : QgsComposerTableV2
     //QList<QPair<int, bool> > sortAttributes() const;
 
     /**Queries the attribute table's vector layer for attributes to show in the table.
-     * @param attributeMaps list of QgsAttributeMaps where the fetched feature attributes will be stored
+     * @param contents table content
      * @returns true if attributes were successfully fetched
      * @note not available in python bindings
      */

python/core/composer/qgscomposerframe.sip

@@ -5,8 +5,9 @@ class QgsComposerFrame: QgsComposerItem
 #include "qgscomposerframe.h"
 %End
 
- public:
+  public:
     QgsComposerFrame( QgsComposition* c /TransferThis/, QgsComposerMultiFrame* mf, qreal x, qreal y, qreal width, qreal height );
+
     ~QgsComposerFrame();
 
     /**Sets the visible part of the multiframe's content which is visible within

python/core/composer/qgscomposerhtml.sip

@@ -15,7 +15,10 @@ class QgsComposerHtml: QgsComposerMultiFrame
     };
 
     QgsComposerHtml( QgsComposition* c /TransferThis/, bool createUndoCommands );
+
+    //should be private - fix for QGIS 3.0
     QgsComposerHtml();
+
     ~QgsComposerHtml();
 
     /**Sets the source mode for item's HTML content.
@@ -192,7 +195,6 @@ class QgsComposerHtml: QgsComposerMultiFrame
 
     /**Recalculates the frame sizes for the current viewport dimensions*/
     void recalculateFrameSizes();
-
     void refreshExpressionContext();
 
     virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties );

python/core/composer/qgscomposeritem.sip

@@ -507,7 +507,7 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
     /**Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE
      * @deprecated use QgsComposerUtils::scaledFontPixelSize instead
      */
-    QFont scaledFontPixelSize( const QFont& font ) const;
+    QFont scaledFontPixelSize( const QFont& font ) const /Deprecated/;
 
     /**Locks / unlocks the item position for mouse drags
      * @param lock set to true to prevent item movement and resizing via the mouse
@@ -672,10 +672,10 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
     /**Draws arrowhead
      * @deprecated use QgsComposerUtils::drawArrowHead instead
      */
-    void drawArrowHead( QPainter* p, double x, double y, double angle, double arrowHeadWidth ) const;
+    void drawArrowHead( QPainter* p, double x, double y, double angle, double arrowHeadWidth ) const /Deprecated/;
 
     /**Returns angle of the line from p1 to p2 (clockwise, starting at N)*/
-    double angle( const QPointF& p1, const QPointF& p2 ) const;
+    double angle( const QPointF& p1, const QPointF& p2 ) const /Deprecated/;
 
     /**Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the
     item border for resizing*/

python/core/composer/qgscomposeritemcommand.sip

@@ -28,7 +28,7 @@ class QgsComposerItemCommand: QUndoCommand
     /**Returns the target item the command applies to.
      * @returns target composer item
     */
-    QgsComposerItem* item() const;
+    QgsComposerItem *item() const;
 
   protected:
     void saveState( QDomDocument& stateDoc ) const;
@@ -94,7 +94,8 @@ class QgsComposerMergeCommand : QgsComposerItemCommand
       ItemOutlineWidth,
       ItemMove,
       ItemRotation,
-      ItemTransparency
+      ItemTransparency,
+      ItemZoomContent
     };
 
     QgsComposerMergeCommand( Context c, QgsComposerItem* item, const QString& text );

python/core/composer/qgscomposeritemgroup.sip

@@ -7,7 +7,7 @@ class QgsComposerItemGroup: QgsComposerItem
     QgsComposerItemGroup( QgsComposition* c /TransferThis/ );
     ~QgsComposerItemGroup();
 
-    /** return correct graphics item type. Added in v1.7 */
+    /** return correct graphics item type. */
     virtual int type() const;
 
     /**Adds an item to the group. All the group members are deleted

python/core/composer/qgscomposermap.sip

@@ -521,7 +521,7 @@ class QgsComposerMap : QgsComposerItem
      */
     QgsComposerMapGrid* grid();
 
-    /**Returns the map item's overview stack, which is used to control how over
+    /**Returns the map item's overview stack, which is used to control how overviews
      * are drawn over the map's contents.
      * @returns pointer to overview stack
      * @see overview()

python/core/composer/qgscomposermapgrid.sip

@@ -105,6 +105,10 @@ class QgsComposerMapGridStack : QgsComposerMapItemStack
 
 };
 
+//
+// QgsComposerMapGrid
+//
+
 /**\ingroup MapComposer
  * \class QgsComposerMapGrid
  * \brief An individual grid which is drawn above the map content in a
@@ -226,7 +230,7 @@ class QgsComposerMapGrid : QgsComposerMapItem
 
     /**Constructor for QgsComposerMapGrid.
      * @param name friendly display name for grid
-     * @parm map QgsComposerMap the grid stack is attached to
+     * @param map QgsComposerMap the grid is attached to
     */
     QgsComposerMapGrid( const QString& name, QgsComposerMap* map );
 
@@ -275,6 +279,8 @@ class QgsComposerMapGrid : QgsComposerMapItem
     */
     QPainter::CompositionMode blendMode() const;
 
+    bool usesAdvancedEffects() const;
+
     /**Calculates the maximum distance the grid extends beyond the QgsComposerMap's
      * item rect
      * @returns maximum extension in millimetres

python/core/composer/qgscomposermapitem.sip

@@ -86,6 +86,7 @@ class QgsComposerMapItem : QgsComposerObject
 };
 
 
+
 /**\ingroup MapComposer
  * \class QgsComposerMapItemStack
  * \brief A collection of map items which are drawn above the map content in a
@@ -154,7 +155,7 @@ class QgsComposerMapItemStack
     void addItem( QgsComposerMapItem* item /Transfer/);
 
     /**Removes an item from the stack and deletes the corresponding QgsComposerMapItem
-     * @param QgsComposerMapItem id for the QgsComposerMapItem to remove
+     * @param itemId id for the QgsComposerMapItem to remove
      * @note after removing an item from the stack, update()
      * should be called for the QgsComposerMap to prevent rendering artifacts
      * @see addItem
@@ -205,7 +206,7 @@ class QgsComposerMapItemStack
      * @see item
      * @note not available in python bindings
     */
-    //QgsComposerMapItem &operator[]( int idx );
+    // QgsComposerMapItem &operator[]( int idx );
 
     /**Returns a list of QgsComposerMapItems contained by the stack
      * @returns list of items

python/core/composer/qgscomposermapoverview.sip

@@ -98,7 +98,6 @@ class QgsComposerMapOverviewStack : QgsComposerMapItemStack
 
 };
 
-
 /**\ingroup MapComposer
  * \class QgsComposerMapOverview
  * \brief An individual overview which is drawn above the map content in a
@@ -173,7 +172,7 @@ class QgsComposerMapOverview : QgsComposerMapItem
     QPainter::CompositionMode blendMode() const;
 
     /**Sets the blending mode used for drawing the overview.
-     * @param mode blending mode for overview
+     * @param blendMode blending mode for overview
      * @see blendMode
     */
     void setBlendMode( const QPainter::CompositionMode blendMode );

python/core/composer/qgscomposermodel.sip

@@ -24,7 +24,8 @@ class QgsComposerModel : QAbstractItemModel
   public:
 
     /**Constructor
-     * @param composition parent composition
+     * @param composition composition to attach to
+     * @param parent parent object
      */
     explicit QgsComposerModel( QgsComposition* composition, QObject* parent = 0 );
 
@@ -39,6 +40,11 @@ class QgsComposerModel : QAbstractItemModel
     Qt::ItemFlags flags( const QModelIndex & index ) const;
     bool setData( const QModelIndex & index, const QVariant & value, int role );
     QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const;
+    Qt::DropActions supportedDropActions() const;
+    virtual QStringList mimeTypes() const;
+    virtual QMimeData* mimeData( const QModelIndexList &indexes ) const;
+    bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent );
+    bool removeRows( int row, int count, const QModelIndex & parent = QModelIndex() );
 
     /**Clears all items from z-order list and resets the model
      * @note added in QGIS 2.5
@@ -164,6 +170,7 @@ class QgsComposerModel : QAbstractItemModel
      * @param item item to update
      * @see updateItemLockStatus
      * @see updateItemVisibility
+     * @see updateItemSelectStatus
      * @note added in QGIS 2.5
      */
     void updateItemDisplayName( QgsComposerItem *item );
@@ -172,6 +179,7 @@ class QgsComposerModel : QAbstractItemModel
      * @param item item to update
      * @see updateItemDisplayName
      * @see updateItemVisibility
+     * @see updateItemSelectStatus
      * @note added in QGIS 2.5
      */
     void updateItemLockStatus( QgsComposerItem *item );
@@ -180,10 +188,20 @@ class QgsComposerModel : QAbstractItemModel
      * @param item item to update
      * @see updateItemDisplayName
      * @see updateItemLockStatus
+     * @see updateItemSelectStatus
      * @note added in QGIS 2.5
      */
     void updateItemVisibility( QgsComposerItem *item );
 
+    /**Must be called when an item's selection status changes
+     * @param item item to update
+     * @see updateItemDisplayName
+     * @see updateItemVisibility
+     * @see updateItemLockStatus
+     * @note added in QGIS 2.5
+     */
+    void updateItemSelectStatus( QgsComposerItem *item );
+
   public slots:
 
     /**Sets an item as the current selection from a QModelIndex

python/core/composer/qgscomposermultiframecommand.sip

@@ -29,7 +29,6 @@ class QgsComposerMultiFrameCommand : QUndoCommand
     bool checkFirstRun();
 };
 
-
 /**A composer command that merges together with other commands having the same context (=id)
  * for multi frame items. Keeps the oldest previous state and uses the newest after state.
  * The purpose is to avoid too many micro changes in the history*/

python/core/composer/qgscomposerobject.sip

@@ -15,6 +15,7 @@ class QgsComposerObject : QObject
     {
       NoProperty = 0, /*< no property */
       AllProperties, /*< all properties for item */
+      TestProperty, /*< dummy property with no effect on item*/
       //composer page properties
       PresetPaperSize, /*< preset paper size for composition */
       PaperWidth, /*< paper width */
@@ -40,7 +41,9 @@ class QgsComposerObject : QObject
       MapYMax, /*< map extent y maximum */
       MapAtlasMargin, /*< map atlas margin*/
       //composer picture
-      PictureSource /*< picture source url */
+      PictureSource, /*< picture source url */
+      //html item
+      SourceUrl /*< html source url */
     };
 
     /** Specifies whether the value returned by a function should be the original, user
@@ -57,7 +60,6 @@ class QgsComposerObject : QObject
      * @param composition parent composition
      */
     QgsComposerObject( QgsComposition* composition );
-
     virtual ~QgsComposerObject();
 
     /**Returns the composition the item is attached to.
@@ -66,7 +68,7 @@ class QgsComposerObject : QObject
     const QgsComposition* composition() const;
 
     /**Stores item state in DOM element
-     * @param elem is DOM element corresponding to 'Composer' tag
+     * @param elem is DOM element corresponding to item tag
      * @param doc is the DOM document
      */
     virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
@@ -88,7 +90,7 @@ class QgsComposerObject : QObject
      * @param active true if data defined property is active, false if it is disabled
      * @param useExpression true if the expression should be used
      * @param expression expression for data defined property
-     * @field field name if the data defined property should take its value from a field
+     * @param field field name if the data defined property should take its value from a field
      * @note this method was added in version 2.5
     */
     void setDataDefinedProperty( const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field );

python/core/composer/qgscomposerpicture.sip

@@ -33,7 +33,7 @@ class QgsComposerPicture: QgsComposerItem
     QgsComposerPicture( QgsComposition *composition /TransferThis/);
     ~QgsComposerPicture();
 
-    /** return correct graphics item type. Added in v1.7 */
+    /** return correct graphics item type. */
     virtual int type() const;
 
     /**Reimplementation of QCanvasItem::paint*/
@@ -57,7 +57,7 @@ class QgsComposerPicture: QgsComposerItem
     */
     QString pictureFile() const /Deprecated/;
 
-     /**Sets the source path of the image (may be svg or a raster format). Data defined
+    /**Sets the source path of the image (may be svg or a raster format). Data defined
      * picture source may override this value. The path can either be a local path
      * or a remote (http) path.
      * @param path path for the source image
@@ -76,7 +76,6 @@ class QgsComposerPicture: QgsComposerItem
     */
     QString picturePath() const;
 
-
     /**Sets this items bound in scene coordinates such that 1 item size units
      * corresponds to 1 scene size unit and resizes the svg symbol / image
     */
@@ -263,6 +262,8 @@ class QgsComposerPicture: QgsComposerItem
      */
     void recalculateSize();
 
+    virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties );
+
   signals:
     /**Is emitted on picture rotation change*/
     void pictureRotationChanged( double newRotation );

python/core/composer/qgscomposertable.sip

@@ -20,7 +20,7 @@ class QgsComposerTable: QgsComposerItem
     QgsComposerTable( QgsComposition* composition /TransferThis/ );
     virtual ~QgsComposerTable();
 
-    /** return correct graphics item type. Added in v1.7 */
+    /** return correct graphics item type. */
     virtual int type() const;
 
     /** \brief Reimplementation of QCanvasItem::paint*/
@@ -219,8 +219,6 @@ class QgsComposerTable: QgsComposerItem
     virtual void adjustFrameToSize();
 
   protected:
-    /**Retrieves feature attributes*/
-    // virtual bool getFeatureAttributes( QList<QgsAttributeMap>& attributeMaps );
     /**Calculates the maximum width of text shown in columns.
      * @param maxWidthMap QMap of int to double in which to store the maximum widths. The int will be filled
      * with the column number and the double with the maximum width of text present in the column.