sipify core composer part 2

python/auto_sip.blacklist

@@ -1,18 +1,5 @@
 core/conversions.sip
 core/qgsexception.sip
-core/composer/qgscomposereffect.sip
-core/composer/qgscomposerframe.sip
-core/composer/qgscomposerhtml.sip
-core/composer/qgscomposeritem.sip
-core/composer/qgscomposeritemcommand.sip
-core/composer/qgscomposeritemgroup.sip
-core/composer/qgscomposerlabel.sip
-core/composer/qgscomposerlegend.sip
-core/composer/qgscomposermapgrid.sip
-core/composer/qgscomposermapitem.sip
-core/composer/qgscomposermapoverview.sip
-core/composer/qgscomposermodel.sip
-core/composer/qgscomposermultiframe.sip
 core/composer/qgscomposermultiframecommand.sip
 core/composer/qgscomposerobject.sip
 core/composer/qgscomposerpicture.sip

python/core/composer/qgscomposereffect.sip

@@ -1,15 +1,39 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/composer/qgscomposereffect.h                                *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
 class QgsComposerEffect : QGraphicsEffect
 {
+
 %TypeHeaderCode
-#include <qgscomposereffect.h>
+#include "qgscomposereffect.h"
 %End
   public:
     QgsComposerEffect();
-    ~QgsComposerEffect();
 
-    void setCompositionMode( const QPainter::CompositionMode &compositionMode );
+    void setCompositionMode( QPainter::CompositionMode compositionMode );
 
   protected:
-    /** Called whenever source needs to be drawn */
     virtual void draw( QPainter *painter );
+%Docstring
+Called whenever source needs to be drawn
+%End
+
 };
+
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/composer/qgscomposereffect.h                                *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/core/composer/qgscomposerframe.sip

@@ -1,82 +1,119 @@
-/** Frame item for a composer multiframe item*/
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/composer/qgscomposerframe.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
 class QgsComposerFrame: QgsComposerItem
 {
+%Docstring
+ Frame item for a composer multiframe item.
+%End
+
 %TypeHeaderCode
 #include "qgscomposerframe.h"
 %End
-
   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
-     * this frame (relative to the total multiframe extent in mm).
-     * @param section visible portion of content
-     * @see extent
-     */
     void setContentSection( const QRectF &section );
+%Docstring
+ Sets the visible part of the multiframe's content which is visible within
+ this frame (relative to the total multiframe extent in mm).
+ \param section visible portion of content
+.. seealso:: extent
+%End
 
-    /** Returns the parent multiframe for the frame.
-     * @returns parent multiframe
-     */
     QgsComposerMultiFrame *multiFrame() const;
+%Docstring
+ Returns the parent multiframe for the frame.
+ :return: parent multiframe
+ :rtype: QgsComposerMultiFrame
+%End
 
-    //Overridden to allow multiframe to set display name
     virtual QString displayName() const;
 
-    //Overridden to handle fixed frame sizes set by multi frame
-    void setSceneRect( const QRectF &rectangle );
-
-    void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget );
-    void beginItemCommand( const QString &text );
-    void endItemCommand();
-    bool writeXml( QDomElement &elem, QDomDocument &doc ) const;
-    bool readXml( const QDomElement &itemElem, const QDomDocument &doc );
-    int type() const;
-
-    /** Returns the visible portion of the multi frame's content which
-     * is shown in this frame.
-     * @returns extent of visible portion
-     * @note added in QGIS 2.5
-     * @see setContentSection
-     */
+    virtual void setSceneRect( const QRectF &rectangle );
+
+
+    virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget );
+
+    virtual void beginItemCommand( const QString &text );
+
+    virtual void endItemCommand();
+
+    virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const;
+
+    virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc );
+
+    virtual int type() const;
+
     QRectF extent() const;
+%Docstring
+ Returns the visible portion of the multi frame's content which
+ is shown in this frame.
+ :return: extent of visible portion
+.. versionadded:: 2.5
+.. seealso:: setContentSection
+ :rtype: QRectF
+%End
 
-    /** Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty
-     * @returns true if page should be hidden if frame is empty
-     * @note added in QGIS 2.5
-     * @see setHidePageIfEmpty
-     */
     bool hidePageIfEmpty() const;
+%Docstring
+ Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty
+ :return: true if page should be hidden if frame is empty
+.. versionadded:: 2.5
+.. seealso:: setHidePageIfEmpty
+ :rtype: bool
+%End
 
-    /** Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty
-     * @param hidePageIfEmpty set to true if page should be hidden if frame is empty
-     * @note added in QGIS 2.5
-     * @see hidePageIfEmpty
-     */
     void setHidePageIfEmpty( const bool hidePageIfEmpty );
+%Docstring
+ Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty
+ \param hidePageIfEmpty set to true if page should be hidden if frame is empty
+.. versionadded:: 2.5
+.. seealso:: hidePageIfEmpty
+%End
 
-    /** Returns whether the background and frame border should be hidden if this frame is empty
-     * @returns true if background and border should be hidden if frame is empty
-     * @note added in QGIS 2.5
-     * @see setHideBackgroundIfEmpty
-     */
     bool hideBackgroundIfEmpty() const;
+%Docstring
+ Returns whether the background and frame stroke should be hidden if this frame is empty
+ :return: true if background and stroke should be hidden if frame is empty
+.. versionadded:: 2.5
+.. seealso:: setHideBackgroundIfEmpty
+ :rtype: bool
+%End
 
-    /** Sets whether the background and frame border should be hidden if this frame is empty
-     * @param hideBackgroundIfEmpty set to true if background and border should be hidden if frame is empty
-     * @note added in QGIS 2.5
-     * @see hideBackgroundIfEmpty
-     */
     void setHideBackgroundIfEmpty( const bool hideBackgroundIfEmpty );
+%Docstring
+ Sets whether the background and frame stroke should be hidden if this frame is empty
+ \param hideBackgroundIfEmpty set to true if background and stroke should be hidden if frame is empty
+.. versionadded:: 2.5
+.. seealso:: hideBackgroundIfEmpty
+%End
 
-    /** Returns whether the frame is empty
-     * @returns true if frame is empty
-     * @note added in QGIS 2.5
-     * @see hidePageIfEmpty
-     */
     bool isEmpty() const;
+%Docstring
+ Returns whether the frame is empty
+ :return: true if frame is empty
+.. versionadded:: 2.5
+.. seealso:: hidePageIfEmpty
+ :rtype: bool
+%End
 
     virtual QgsExpressionContext createExpressionContext() const;
+
 };
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/composer/qgscomposerframe.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/