Skip to content
Permalink
Browse files
Replace "python" with "Python" in docs
  • Loading branch information
nyalldawson committed Apr 2, 2017
1 parent 1521033 commit 32326ab5df199b9bd47e66bd60430075cdf151c9
Showing with 268 additions and 268 deletions.
  1. +1 −1 src/analysis/interpolation/DualEdgeTriangulation.h
  2. +3 −3 src/analysis/raster/qgsrastermatrix.h
  3. +1 −1 src/app/pluginmanager/qgsapppluginmanagerinterface.h
  4. +2 −2 src/app/pluginmanager/qgspluginmanager.h
  5. +4 −4 src/app/qgisapp.h
  6. +1 −1 src/app/qgspluginregistry.h
  7. +1 −1 src/app/qgsprojectproperties.h
  8. +2 −2 src/core/composer/qgscomposerattributetablev2.h
  9. +1 −1 src/core/composer/qgscomposermap.h
  10. +2 −2 src/core/composer/qgscomposermapgrid.h
  11. +1 −1 src/core/composer/qgscomposermapitem.h
  12. +1 −1 src/core/composer/qgscomposermapoverview.h
  13. +1 −1 src/core/composer/qgscomposerobject.h
  14. +4 −4 src/core/composer/qgscomposertablev2.h
  15. +7 −7 src/core/composer/qgscomposition.h
  16. +4 −4 src/core/dxf/qgsdxfexport.h
  17. +6 −6 src/core/effects/qgspainteffectregistry.h
  18. +9 −9 src/core/geometry/qgsgeometry.h
  19. +3 −3 src/core/gps/qgsqtlocationconnection.h
  20. +3 −3 src/core/layertree/qgslayertree.h
  21. +1 −1 src/core/layertree/qgslayertreeutils.h
  22. +1 −1 src/core/qgsactionmanager.h
  23. +2 −2 src/core/qgsanimatedicon.h
  24. +1 −1 src/core/qgsapplication.h
  25. +1 −1 src/core/qgsbrowsermodel.h
  26. +1 −1 src/core/qgsclipper.h
  27. +1 −1 src/core/qgscolorschemeregistry.h
  28. +2 −2 src/core/qgscoordinatereferencesystem.h
  29. +5 −5 src/core/qgscoordinatetransform.h
  30. +2 −2 src/core/qgsdataitem.h
  31. +2 −2 src/core/qgsdatasourceuri.h
  32. +1 −1 src/core/qgsdistancearea.h
  33. +17 −17 src/core/qgseditformconfig.h
  34. +2 −2 src/core/qgseditformconfig_p.h
  35. +1 −1 src/core/qgsexpressioncontext.h
  36. +1 −1 src/core/qgsfeaturerequest.h
  37. +1 −1 src/core/qgsgml.h
  38. +3 −3 src/core/qgslabelsearchtree.h
  39. +2 −2 src/core/qgslogger.h
  40. +1 −1 src/core/qgsmaplayermodel.h
  41. +1 −1 src/core/qgsmaplayerref.h
  42. +1 −1 src/core/qgsmaprenderercustompainterjob.h
  43. +6 −6 src/core/qgsmaprendererjob.h
  44. +1 −1 src/core/qgsmapsettings.h
  45. +1 −1 src/core/qgsmapthemecollection.h
  46. +2 −2 src/core/qgsmaptopixel.h
  47. +2 −2 src/core/qgsmessageoutput.h
  48. +1 −1 src/core/qgsoptional.h
  49. +1 −1 src/core/qgspallabeling.h
  50. +8 −8 src/core/qgsproject.h
  51. +6 −6 src/core/qgspythonrunner.h
  52. +2 −2 src/core/qgsrelation.h
  53. +1 −1 src/core/qgsrenderchecker.h
  54. +1 −1 src/core/qgsruntimeprofiler.h
  55. +2 −2 src/core/qgsspatialindex.h
  56. +3 −3 src/core/qgsvectorfilewriter.h
  57. +8 −8 src/core/qgsvectorlayer.h
  58. +1 −1 src/core/qgsvectorlayercache.h
  59. +4 −4 src/core/qgsvectorlayereditutils.h
  60. +6 −6 src/core/raster/qgsrasterblock.h
  61. +3 −3 src/core/raster/qgsrasterdataprovider.h
  62. +1 −1 src/core/raster/qgsrasterdrawer.h
  63. +1 −1 src/core/raster/qgsrasterhistogram.h
  64. +3 −3 src/core/raster/qgsrasterinterface.h
  65. +4 −4 src/core/raster/qgsrasterlayer.h
  66. +1 −1 src/core/raster/qgsrasterrange.h
  67. +1 −1 src/core/raster/qgssinglebandpseudocolorrenderer.h
  68. +1 −1 src/core/symbology-ng/qgscptcityarchive.h
  69. +3 −3 src/core/symbology-ng/qgsgraduatedsymbolrenderer.h
  70. +2 −2 src/core/symbology-ng/qgsheatmaprenderer.h
  71. +1 −1 src/core/symbology-ng/qgsinvertedpolygonrenderer.h
  72. +1 −1 src/core/symbology-ng/qgsrenderer.h
  73. +6 −6 src/core/symbology-ng/qgsrendererregistry.h
  74. +3 −3 src/core/symbology-ng/qgsrulebasedrenderer.h
  75. +1 −1 src/core/symbology-ng/qgssvgcache.h
  76. +2 −2 src/core/symbology-ng/qgssymbollayer.h
  77. +6 −6 src/core/symbology-ng/qgssymbollayerregistry.h
  78. +3 −3 src/core/symbology-ng/qgssymbollayerutils.h
  79. +1 −1 src/gui/attributetable/qgsattributetablemodel.h
  80. +2 −2 src/gui/editorwidgets/core/qgseditorwidgetregistry.h
  81. +3 −3 src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
  82. +1 −1 src/gui/effects/qgseffectstackpropertieswidget.h
  83. +2 −2 src/gui/qgsattributeform.h
  84. +1 −1 src/gui/qgsattributeformeditorwidget.h
  85. +2 −2 src/gui/qgscodeeditorpython.h
  86. +1 −1 src/gui/qgsidentifymenu.h
  87. +2 −2 src/gui/qgsmapcanvas.h
  88. +1 −1 src/gui/qgsmapcanvassnapper.h
  89. +1 −1 src/gui/qgsmaptool.h
  90. +1 −1 src/gui/qgsmaptooladvanceddigitizing.h
  91. +1 −1 src/gui/qgsowssourceselect.h
  92. +1 −1 src/gui/qgspluginmanagerinterface.h
  93. +1 −1 src/gui/raster/qgsrasterhistogramwidget.h
  94. +1 −1 src/gui/symbology-ng/qgsrulebasedrendererwidget.h
  95. +2 −2 src/gui/symbology-ng/qgssmartgroupeditordialog.h
  96. +3 −3 src/gui/symbology-ng/qgssymbollevelsdialog.h
  97. +4 −4 src/gui/symbology-ng/qgssymbolselectordialog.h
  98. +8 −8 src/python/qgspythonutils.h
  99. +13 −13 src/python/qgspythonutilsimpl.h
  100. +2 −2 src/server/qgsserver.h
  101. +3 −3 src/server/qgsserverinterface.h
  102. +1 −1 src/server/qgsserverplugins.h
  103. +1 −1 src/server/qgsserverrequest.h
  104. +3 −3 src/server/qgsserverresponse.h
@@ -59,7 +59,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
//! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)
int getOppositePoint( int p1, int p2 ) override;
//! Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'
//! @note not available in python bindings
//! @note not available in Python bindings
virtual bool getTriangle( double x, double y, Point3D *p1, int *n1, Point3D *p2, int *n2, Point3D *p3, int *n3 ) override;
//! Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3
virtual bool getTriangle( double x, double y, Point3D *p1, Point3D *p2, Point3D *p3 ) override;
@@ -60,7 +60,7 @@ class ANALYSIS_EXPORT QgsRasterMatrix

//! Takes ownership of data array
QgsRasterMatrix();
//! @note note available in python bindings
//! @note note available in Python bindings
QgsRasterMatrix( int nCols, int nRows, double *data, double nodataValue );
QgsRasterMatrix( const QgsRasterMatrix &m );
~QgsRasterMatrix();
@@ -70,10 +70,10 @@ class ANALYSIS_EXPORT QgsRasterMatrix
double number() const { return mData[0]; }

//! Returns data array (but not ownership)
//! @note not available in python bindings
//! @note not available in Python bindings
double *data() { return mData; }
//! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0
//! @note not available in python bindings
//! @note not available in Python bindings
double *takeData();

void setData( int cols, int rows, double *data, double nodataValue );
@@ -36,7 +36,7 @@ class QgsAppPluginManagerInterface : public QgsPluginManagerInterface

~QgsAppPluginManagerInterface();

//! remove python plugins from the metadata registry (c++ plugins stay)
//! remove Python plugins from the metadata registry (c++ plugins stay)
void clearPythonPluginMetadata() override;

//! add a single plugin to the metadata registry
@@ -52,7 +52,7 @@ class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManag

~QgsPluginManager();

//! Save pointer to python utils and enable Python support
//! Save pointer to Python utils and enable Python support
void setPythonUtils( QgsPythonUtils *pythonUtils );

//! Load selected plugin
@@ -76,7 +76,7 @@ class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManag
//! Fill the html browser widget with plugin details
void showPluginDetails( QStandardItem *item );

//! Remove python plugins from the metadata registry (c++ plugins stay)
//! Remove Python plugins from the metadata registry (c++ plugins stay)
void clearPythonPluginMetadata();

//! Add a single plugin to the metadata registry
@@ -941,7 +941,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void decreaseContrast();
//! plugin manager
void showPluginManager();
//! load python support if possible
//! load Python support if possible
void loadPythonSupport();

/** Install plugin from ZIP file
@@ -1068,8 +1068,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! text)= of the given action.
void openProject( QAction *action );

/** Attempts to run a python script
* @param filePath full path to python script
/** Attempts to run a Python script
* @param filePath full path to Python script
* @note added in QGIS 2.7
*/
void runScript( const QString &filePath );
@@ -1353,7 +1353,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! save current raster layer
void saveAsRasterFile();

//! show python console
//! show Python console
void showPythonDialog();

//! Shows a warning when an old project file is read.
@@ -67,7 +67,7 @@ class APP_EXPORT QgsPluginRegistry
//! Unload plugins
void unloadAll();

//! Save pointer for python utils (needed for unloading python plugins)
//! Save pointer for Python utils (needed for unloading Python plugins)
void setPythonUtils( QgsPythonUtils *pythonUtils );

//! Dump list of plugins
@@ -191,7 +191,7 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
void restoreState();

/*!
* Reset the python macros
* Reset the Python macros
*/
void resetPythonMacros();

@@ -269,7 +269,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* @returns a QList of integer/bool pairs, where the integer refers to the attribute index and
* the bool to the sort order for the attribute. If true the attribute is sorted ascending,
* if false, the attribute is sorted in descending order.
* @note not available in python bindings
* @note not available in Python bindings
*/
QList<QPair<int, bool> > sortAttributes() const;

@@ -292,7 +292,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
/** Queries the attribute table's vector layer for attributes to show in the table.
* @param contents table content
* @returns true if attributes were successfully fetched
* @note not available in python bindings
* @note not available in Python bindings
*/
bool getTableContents( QgsComposerTableContents &contents ) override;

@@ -165,7 +165,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
*/
const QgsRectangle *currentMapExtent() const;

//! @note not available in python bindings
//! @note not available in Python bindings
QgsRectangle *currentMapExtent();

/**
@@ -487,7 +487,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* @see setLineSymbol
* @see markerSymbol
* @see style
* @note not available in python bindings
* @note not available in Python bindings
*/
const QgsLineSymbol *lineSymbol() const { return mGridLineSymbol; }

@@ -515,7 +515,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* @see setMarkerSymbol
* @see lineSymbol
* @see style
* @note not available in python bindings
* @note not available in Python bindings
*/
const QgsMarkerSymbol *markerSymbol() const { return mGridMarkerSymbol; }

@@ -234,7 +234,7 @@ class CORE_EXPORT QgsComposerMapItemStack
* @returns reference to item if found
* @see constItem
* @see item
* @note not available in python bindings
* @note not available in Python bindings
*/
QgsComposerMapItem &operator[]( int idx );

@@ -192,7 +192,7 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
/** Gets the fill symbol used for drawing the overview extent.
* @returns fill symbol for overview
* @see setFrameSymbol
* @note not available in python bindings
* @note not available in Python bindings
*/
const QgsFillSymbol *frameSymbol() const { return mFrameSymbol; }

@@ -115,7 +115,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
*/
const QgsComposition *composition() const { return mComposition; }

//! @note not available in python bindings
//! @note not available in Python bindings
QgsComposition *composition() { return mComposition; }

/** Stores item state in DOM element
@@ -440,14 +440,14 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
/** Returns the text used in the column headers for the table.
* @returns QMap of int to QString, where the int is the column index (starting at 0),
* and the string is the text to use for the column's header
* @note not available in python bindings
* @note not available in Python bindings
*/
virtual QMap<int, QString> headerLabels() const;

/** Fetches the contents used for the cells in the table.
* @returns true if table contents were successfully retrieved.
* @param contents QgsComposerTableContents to store retrieved row data in
* @note not available in python bindings
* @note not available in Python bindings
*/
virtual bool getTableContents( QgsComposerTableContents &contents ) = 0;

@@ -619,10 +619,10 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* table, then the default row height will be used for the remaining rows.
* @param hasHeader set to true if table frame includes header cells
* @param mergeCells set to true to merge table content cells
* @note not available in python bindings
* @note not available in Python bindings
* @see drawVerticalGridLines
* @see calculateMaxColumnWidths
* @note not available in python bindings
* @note not available in Python bindings
* @note added in QGIS 2.12
*/
void drawVerticalGridLines( QPainter *painter, const QMap<int, double> &maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells = false ) const;
@@ -384,20 +384,20 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
QList<QgsComposerItem *> selectedComposerItems( const bool includeLockedItems = true );

/** Returns pointers to all composer maps in the scene
@note available in python bindings only with PyQt >= 4.8.4
@note available in Python bindings only with PyQt >= 4.8.4
*/
QList<const QgsComposerMap *> composerMapItems() const;

/** Return composer items of a specific type
* @param itemList list of item type to store matching items in
* @note not available in python bindings
* @note not available in Python bindings
*/
template<class T> void composerItems( QList<T *> &itemList );

/** Return composer items of a specific type on a specified page
* @param itemList list of item type to store matching items in
* @param pageNumber page number (0 based)
* @note not available in python bindings
* @note not available in Python bindings
* @note added in QGIS 2.5
*/
template<class T> void composerItemsOnPage( QList<T *> &itemList, const int pageNumber ) const;
@@ -487,7 +487,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param addUndoCommands insert AddItem commands if true (e.g. for copy/paste)
* @param pos item position. Optional, take position from xml if 0
* @param pasteInPlace whether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor)
* @note parameters mapsToRestore, addUndoCommands pos and pasteInPlace not available in python bindings
* @note parameters mapsToRestore, addUndoCommands pos and pasteInPlace not available in Python bindings
*/
void addItemsFromXml( const QDomElement &elem, const QDomDocument &doc,
bool addUndoCommands = false, QPointF *pos = nullptr, bool pasteInPlace = false );
@@ -559,7 +559,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
QList< QGraphicsLineItem * > *snapLines() {return &mSnapLines;}

/** Returns pointer to selection handles
* @note not available in python bindings
* @note not available in Python bindings
*/
QgsComposerMouseHandles *selectionHandles() {return mSelectionHandles;}

@@ -569,7 +569,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
void removeSnapLine( QGraphicsLineItem *line );

/** Get nearest snap line
* @note not available in python bindings
* @note not available in Python bindings
*/
QGraphicsLineItem *nearestSnapLine( const bool horizontal, const double x, const double y, const double tolerance, QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &snappedItems ) const;

@@ -596,7 +596,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
void removeMultiFrame( QgsComposerMultiFrame *multiFrame );

/** Adds an arrow item to the graphics scene and advises composer to create a widget for it (through signal)
@note not available in python bindings*/
@note not available in Python bindings*/
void addComposerArrow( QgsComposerArrow *arrow );
//! Adds label to the graphics scene and advises composer to create a widget for it (through signal)
void addComposerLabel( QgsComposerLabel *label );
@@ -176,15 +176,15 @@ class CORE_EXPORT QgsDxfExport
* Write a tuple of group code and integer value
* @param code group code
* @param i integer value
* @note available in python bindings as writeGroupInt
* @note available in Python bindings as writeGroupInt
*/
void writeGroup( int code, int i );

/**
* Write a group code with a floating point value
* @param code group code
* @param d floating point value
* @note available in python bindings as writeGroupDouble
* @note available in Python bindings as writeGroupDouble
*/
void writeGroup( int code, double d );

@@ -199,7 +199,7 @@ class CORE_EXPORT QgsDxfExport
* Write a group code with a point
* @param code group code
* @param p point value
* @note available in python bindings as writeGroupPointV2
* @note available in Python bindings as writeGroupPointV2
* @note added in 2.15
*/
void writeGroup( int code, const QgsPointV2 &p );
@@ -210,7 +210,7 @@ class CORE_EXPORT QgsDxfExport
* @param exactMatch group code to use if the color has an exact match in the dxf palette
* @param rgbCode group code to use if the color doesn't have an exact match or has a transparency component
* @param transparencyCode group code to use for transparency component
* @note available in python bindings as writeGroupPoint
* @note available in Python bindings as writeGroupPoint
*/
void writeGroup( const QColor &color, int exactMatch = 62, int rgbCode = 420, int transparencyCode = 440 );

@@ -95,7 +95,7 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
* @param visibleName user visible name representing paint effect class
* @param pfCreate paint effect creation function
* @param pfWidget widget creation function
* @note not available in python bindings
* @note not available in Python bindings
*/
QgsPaintEffectMetadata( const QString &name, const QString &visibleName,
QgsPaintEffectCreateFunc pfCreate,
@@ -107,35 +107,35 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata

/** Returns the paint effect creation function for the paint effect class
* @returns creation function
* @note not available in python bindings
* @note not available in Python bindings
*/
QgsPaintEffectCreateFunc createFunction() const { return mCreateFunc; }

/** Returns the paint effect properties widget creation function for the paint effect class
* @returns widget creation function
* @note not available in python bindings
* @note not available in Python bindings
* @see setWidgetFunction
*/
QgsPaintEffectWidgetFunc widgetFunction() const { return mWidgetFunc; }

/** Sets the paint effect properties widget creation function for the paint effect class
* @param f widget creation function
* @note not available in python bindings
* @note not available in Python bindings
* @see widgetFunction
*/
void setWidgetFunction( QgsPaintEffectWidgetFunc f ) { mWidgetFunc = f; }

/** Creates a new paint effect of the metadata's effect class
* @param map string map of effect properties
* @returns new paint effect
* @note not available in python bindings
* @note not available in Python bindings
* @see createWidget
*/
virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) override { return mCreateFunc ? mCreateFunc( map ) : nullptr; }

/** Creates a new paint effect properties widget for the metadata's effect class
* @returns effect properties widget
* @note not available in python bindings
* @note not available in Python bindings
* @see createWidget
*/
virtual QgsPaintEffectWidget *createWidget() override { return mWidgetFunc ? mWidgetFunc() : nullptr; }
Loading

0 comments on commit 32326ab

Please sign in to comment.