/************************************************************************ * This file has been generated automatically from * * * * tests/scripts/sipifyheader.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/ % ModuleHeaderCode #include #include %End typedef qint64 QgsFeatureId; typedef QSet QgsFeatureIds; typedef QMap> QgsChangedAttributesMap; typedef QMap > QgsChangedAttributesMap; typedef QMap> QgsChangedAttributesMap; typedef QVector QgsSuperClass; %MappedType QgsSuperClass { // The annotations are modified by astyle (these will be fixed by sipify.pl) %TypeHeaderCode #include %End %ConvertFromTypeCode // Create the list. PyObject *l; return l; %End } class QgsSipifyHeader : QtClass { %Docstring Documentation goes here Here's some comment mentioning another class QgsAutoAwesomemater.makeAwesome. .. versionadded:: 3.0 .. note:: some other note %End %TypeHeaderCode #include "sipifyheader.h" %End %ConvertToSubClassCode if ( sipCpp->headerType() == QgsSipifyHeader::Special ) sipType = sipType_QgsSpecialSipifyHeader; else sipType = sipType_QgsStandardSipifyHeader; %End public: enum MyEnum { Success, NoSuccess, ImaginarySuccess, RecursiveSuccess, SuccessCombination, }; typedef QFlags Flags; enum OneLiner { Success, NoSuccess }; struct Data { Data( QgsMapLayer *layer, Qstring name ); QString mName; int mCount; QgsMapLayer *mLayer; }; static const int MONTHS; explicit QgsSipifyHeader(); %Docstring A constructor with definition in header %End QgsSipifyHeader( QWidget *parent /TransferThis/ = 0 ); %Docstring A classic constructor with arguments %End QgsSipifyHeader( bool a = true ); %Docstring A constructor with no empty `()` %End QgsSipifyHeader( QList a, const Issues &b = Issues::weDontHaveIssues(), QgsClass *b = 0 ); %Docstring A constructor with some special character types %End Constructor(); virtual ~Destructor(); Constructor( const QString &name, bool optional = false, const QVariant &defaultValue = QVariant() ); QgsSipifyHeader(); %Docstring Default constructor %End bool operator==( const QgsSipifyHeader other ); %Docstring Comparison operator should be kept :rtype: bool %End void multilineMethod( const QgsPoint &startPoint, QgsFeatureId featureId, QgsVectorLayer *vl, QgsSnappingResult::SnappingType snap_to ) const; %Docstring A multiline method signature %End void nonAnnotatedMethodFollowingSkip(); virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) /Factory/; %Docstring Factory annotation :rtype: QgsMapLayerRenderer %End SomeObject *createAnother() /Factory/; %Docstring :rtype: SomeObject %End virtual SomeObject *createAnother2() /Factory/; void LongDocStringMethod(); %Docstring My long doc string is not very interesting! %End void LongDocStringMethodWithBrief(); %Docstring some brief My long doc ``string`` is not very interesting! Here's some comment mentioning another class QgsAutoAwesomemater.makeLessAwesome. %End MyPointer *pointerReturnValue(); %Docstring I return a pointer. If something bad happens, I return None. :return: pointer to something cool :rtype: MyPointer %End bool isOKwithErrMesg( QString &ErrMsg /Out/ ); %Docstring :rtype: bool %End void InOutParam( bool &ok = true /In,Out/ ); void setDiagramRenderer( QgsDiagramRenderer *r /Transfer/ ); void differentDefaultValue( bool defaultValue = false , QWidget *parent = 0, QString msg = "hello" ); void differentType( QList & list ); void complexDefaultValueAndType( QList>> list = QList>> ); %Docstring complex default value and type (i.e. containing commas) should be given as a string with single quotes %End int inlineKeyWordShouldNotAppear(); %Docstring :rtype: int %End QString labelForRange( double lower, double upper ) const /PyName=labelForLowerUpper/; %Docstring :rtype: str %End void setComposition( QgsComposition *c /KeepReference/ ); void removeProxyFactory( QNetworkProxyFactory *factory /TransferBack/ ); bool removeFunctionBody( const QList &list, QgsVectorLayer *vl, Some::Thing _part = -1 /*default =-1*/ ); %Docstring :rtype: bool %End void multilineBodyAndDefinition( const QList &list, QgsVectorLayer *vl, Some::Thing _part = -1 /*default =-1*/ ); QgsRaster::RasterBuildPyramids buildPyramidsFlag() const; %Docstring Removing function body with namespaced return value :rtype: QgsRaster.RasterBuildPyramids %End virtual const QgsLayerMetadata &metadata() const; %Docstring Removing function body with virtual const reference :rtype: QgsLayerMetadata %End bool myMultiLineBody(); %Docstring Mulitline body :rtype: bool %End virtual int overriddenProperty(); virtual int overrideWithoutVirtual(); virtual void overrideWithoutVirtualMultLine( const QList &list1, const QList &list2 ); QString returnTypeString() const; %Docstring :rtype: str %End double returnTypeDouble() const; %Docstring :rtype: float %End QList< QgsAnnotation * > returnTypeList(); %Docstring :rtype: list of QgsAnnotation %End QVector< QgsAnnotation > returnTypeVector(); %Docstring :rtype: list of QgsAnnotation %End QStringList returnTypeStringList(); %Docstring :rtype: list of str %End QSet returnTypeSet(); %Docstring :rtype: set of QgsActionScope %End This shouldBeIncluded; static QString invokableMethod(); %Docstring :rtype: str %End bool initializedMember; struct PublicStruct { explicit PublicStruct( int _part = -1, int _ring = -1, int _vertex = -1, VertexType _type = SegmentVertex ); bool isValid( const QgsAbstractGeometry *geom ) const; %Docstring :rtype: bool %End int part; int ring; int vertex; VertexType type; } void combinedAnnotations() /Factory,PyName=otherName/; void multiAnnotationArg( SomeClass **object /Out,TransferBack/, int &another /Out/ ); void simple( ); %Docstring remove argument %End void method( ); void test( ); void avoidIntersections( const QList &avoidIntersectionsLayers ); void position( ); void position( bool keep ); void position( bool keep, bool keep ); void position( bool keep ); static SIP_PYLIST changeReturnType( QVector *resultTree = 0, QVector &resultCost = 0 ); Whatever &operator[]( int i ) /Factory/; %MethodCode .... %End void ZshouldBeShown(); void methodCodeWithMultiLineDef(); %MethodCode if ( QgsWkbTypes::flatType( a0 ) != QgsWkbTypes::Point ) { multiLineDef( PyExc_ValueError, QString( "%1 is not nice" ).arg( QgsWkbTypes::displayString( a0 ) ).toUtf8().constData() ); } else { sipCpp = new sipQgsPointV2( a0, a1, a2, a3, a4 ); } %End protected: bool thisShouldBeListed(); %Docstring :rtype: bool %End private: void privateMethodSIPRUNareShown(); public: void FallBackToPublic(); private: void ShowThisPrivateOne() ; }; class ClassWithPrivateInheritanceOnly { %Docstring Documentation goes here %End %TypeHeaderCode #include "sipifyheader.h" %End public: explicit ClassWithPrivateInheritanceOnly(); %Docstring A constructor with definition in header on several lines %End }; class AbstractClass /Abstract/ { %Docstring Documentation goes here %End %TypeHeaderCode #include "sipifyheader.h" %End public: explicit AbstractClass(); %Docstring A constructor %End }; QFlags operator|(QgsSipifyHeader::MyEnum f1, QFlags f2); /************************************************************************ * This file has been generated automatically from * * * * tests/scripts/sipifyheader.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/