Skip to content
Permalink
Browse files

remove the-prefix from source code

this might result in variables having the same name as some methods
  • Loading branch information
3nids committed Feb 21, 2017
1 parent 293e1ee commit 7812d4fb17fa5ed66ae86c78e144036ed9b77a8d
Showing 384 changed files with 3,790 additions and 3,786 deletions.
@@ -326,15 +326,15 @@ class QgsComposition : QGraphicsScene, QgsExpressionContextGenerator

/** Returns a composer item given its text identifier.
* Ids are not necessarely unique, but this function returns only one element.
* @param theId - A QString representing the identifier of the item to retrieve.
* @param id - A QString representing the identifier of the item to retrieve.
* @return QgsComposerItem pointer or 0 pointer if no such item exists.
*/
const QgsComposerItem* getComposerItemById( const QString& theId ) const;
const QgsComposerItem* getComposerItemById( const QString& id ) const;

/** Returns a composer item given its unique identifier.
* @param theUuid A QString representing the UUID of the item to
* @param uuid A QString representing the UUID of the item to
*/
const QgsComposerItem* getComposerItemByUuid( const QString& theUuid ) const;
const QgsComposerItem* getComposerItemByUuid( const QString& uuid ) const;

int printResolution() const;
void setPrintResolution( const int dpi );
@@ -104,7 +104,7 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
* based on the supplied theme name exists. If it does not the theme name will
* be reverted to 'default'.
*/
static void setThemeName( const QString &theThemeName );
static void setThemeName( const QString &themeName );

/** Set the active theme to the specified theme.
* The theme name should be a single word e.g. 'default','classic'.
@@ -218,11 +218,11 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)

//! Helper to get a theme icon. It will fall back to the
//! default theme if the active theme does not have the required icon.
static QIcon getThemeIcon( const QString &theName );
static QIcon getThemeIcon( const QString &name );

//! Helper to get a theme icon as a pixmap. It will fall back to the
//! default theme if the active theme does not have the required icon.
static QPixmap getThemePixmap( const QString &theName );
static QPixmap getThemePixmap( const QString &name );

//! Returns the path to user's style.
static QString userStylePath();
@@ -275,19 +275,19 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
static QString libexecPath();

//! Alters prefix path - used by 3rd party apps
static void setPrefixPath( const QString &thePrefixPath, bool useDefaultPaths = false );
static void setPrefixPath( const QString &prefixPath, bool useDefaultPaths = false );

//! Alters plugin path - used by 3rd party apps
static void setPluginPath( const QString &thePluginPath );
static void setPluginPath( const QString &pluginPath );

//! Alters pkg data path - used by 3rd party apps
static void setPkgDataPath( const QString &thePkgDataPath );
static void setPkgDataPath( const QString &pkgDataPath );

//! Alters default svg paths - used by 3rd party apps.
static void setDefaultSvgPaths( const QStringList& pathList );

//! Alters authentication data base directory path - used by 3rd party apps
static void setAuthDatabaseDirPath( const QString& theAuthDbDirPath );
static void setAuthDatabaseDirPath( const QString& authDbDirPath );

//! loads providers
static void initQgis();
@@ -352,13 +352,13 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
* and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. The
* driver name should be the short format of the Gdal driver name e.g. GTIFF.
*/
static void skipGdalDriver( const QString& theDriver );
static void skipGdalDriver( const QString& driver );

/** Sets the GDAL_SKIP environment variable to exclude the specified driver
* and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. The
* driver name should be the short format of the Gdal driver name e.g. GTIFF.
*/
static void restoreGdalDriver( const QString& theDriver );
static void restoreGdalDriver( const QString& driver );

/** Returns the list of gdal drivers that should be skipped (based on
* GDAL_SKIP environment variable)
@@ -168,20 +168,20 @@ class QgsCoordinateReferenceSystem
* - "WKT:<wkt>" - handled with createFromWkt()
*
* If no prefix is specified, WKT definition is assumed.
* @param theDefinition A String containing a coordinate reference system definition.
* @param definition A String containing a coordinate reference system definition.
* @see createFromString()
*/
// TODO QGIS 3: remove "POSTGIS" and "INTERNAL", allow PROJ4 without the prefix
explicit QgsCoordinateReferenceSystem( const QString& theDefinition );
explicit QgsCoordinateReferenceSystem( const QString& definition );

/** Constructor a CRS object using a postgis SRID, an EPSG code or an internal QGIS CRS ID.
* @note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code
* wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile.
* @param theId The ID valid for the chosen CRS ID type
* @param theType One of the types described in CrsType
* @param id The ID valid for the chosen CRS ID type
* @param type One of the types described in CrsType
*/
// TODO QGIS 3: remove theType and always use EPSG code
QgsCoordinateReferenceSystem( const long theId, CrsType theType = PostgisCrsId );
// TODO QGIS 3: remove type and always use EPSG code
QgsCoordinateReferenceSystem( const long id, CrsType type = PostgisCrsId );

static QList< long > validSrsIds();

@@ -234,8 +234,8 @@ class QgsCoordinateReferenceSystem
* wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile.
* @return True on success else false
*/
// TODO QGIS 3: remove theType and always use EPSG code, rename to createFromEpsg
bool createFromId( const long theId, CrsType theType = PostgisCrsId );
// TODO QGIS 3: remove type and always use EPSG code, rename to createFromEpsg
bool createFromId( const long id, CrsType type = PostgisCrsId );

/**
* Sets this CRS to the given OGC WMS-format Coordinate Reference Systems.
@@ -247,14 +247,14 @@ class QgsCoordinateReferenceSystem
* @return True on success else false
*/
// TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid())
bool createFromOgcWmsCrs( const QString& theCrs );
bool createFromOgcWmsCrs( const QString& crs );

/** Sets this CRS by lookup of the given PostGIS SRID in the CRS database.
* @param theSrid The postgis SRID for the desired spatial reference system.
* @param srid The postgis SRID for the desired spatial reference system.
* @return True on success else false
*/
// TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead
bool createFromSrid( const long theSrid );
bool createFromSrid( const long srid );

/** Sets this CRS using a WKT definition.
*
@@ -264,20 +264,20 @@ class QgsCoordinateReferenceSystem
* set up the object.
* @note Some members may be left blank if no match can be found in CRS database.
* @note this method uses an internal cache. Call invalidateCache() to clear the cache.
* @param theWkt The WKT for the desired spatial reference system.
* @param wkt The WKT for the desired spatial reference system.
* @return True on success else false
*/
bool createFromWkt( const QString &theWkt );
bool createFromWkt( const QString &wkt );

/** Sets this CRS by lookup of internal QGIS CRS ID in the CRS database.
*
* If the srsid is < USER_CRS_START_ID, system CRS database is used, otherwise
* user's local CRS database from home directory is used.
* @note this method uses an internal cache. Call invalidateCache() to clear the cache.
* @param theSrsId The internal QGIS CRS ID for the desired spatial reference system.
* @param srsId The internal QGIS CRS ID for the desired spatial reference system.
* @return True on success else false
*/
bool createFromSrsId( const long theSrsId );
bool createFromSrsId( const long srsId );

/** Sets this CRS by passing it a PROJ.4 style formatted string.
*
@@ -297,10 +297,10 @@ class QgsCoordinateReferenceSystem
*
* @note Some members may be left blank if no match can be found in CRS database.
* @note this method uses an internal cache. Call invalidateCache() to clear the cache.
* @param theProjString A proj4 format string
* @param projString A proj4 format string
* @return True on success else false
*/
bool createFromProj4( const QString &theProjString );
bool createFromProj4( const QString &projString );

/** Set up this CRS from a string definition.
*
@@ -312,10 +312,10 @@ class QgsCoordinateReferenceSystem
* - "WKT:<wkt>" - handled with createFromWkt()
*
* If no prefix is specified, WKT definition is assumed.
* @param theDefinition A String containing a coordinate reference system definition.
* @param definition A String containing a coordinate reference system definition.
* @return True on success else false
*/
bool createFromString( const QString &theDefinition );
bool createFromString( const QString &definition );

/** Set up this CRS from various text formats.
*
@@ -328,11 +328,11 @@ class QgsCoordinateReferenceSystem
* ( http://www.gdal.org/ogr/classOGRSpatialReference.html#aec3c6a49533fe457ddc763d699ff8796 )
* @note this function generates a WKT string using OSRSetFromUserInput() and
* passes it to createFromWkt() function.
* @param theDefinition A String containing a coordinate reference system definition.
* @param definition A String containing a coordinate reference system definition.
* @return True on success else false
*/
// TODO QGIS3: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend
bool createFromUserInput( const QString &theDefinition );
bool createFromUserInput( const QString &definition );

/** Make sure that ESRI WKT import is done properly.
* This is required for proper shapefile CRS import when using gdal>= 1.9.
@@ -372,24 +372,24 @@ class QgsCoordinateReferenceSystem
*
* Internally it will use authid() for comparison.
*/
bool operator==( const QgsCoordinateReferenceSystem &theSrs ) const;
bool operator==( const QgsCoordinateReferenceSystem &srs ) const;
/** Overloaded != operator used to compare to CRS's.
*
* Returns opposite bool value to operator ==
*/
bool operator!=( const QgsCoordinateReferenceSystem &theSrs ) const;
bool operator!=( const QgsCoordinateReferenceSystem &srs ) const;

/** Restores state from the given DOM node.
* @param theNode The node from which state will be restored
* @param node The node from which state will be restored
* @return bool True on success, False on failure
*/
bool readXml( const QDomNode & theNode );
bool readXml( const QDomNode & node );
/** Stores state to the given Dom node in the given document.
* @param theNode The node in which state will be restored
* @param theDoc The document in which state will be stored
* @param node The node in which state will be restored
* @param doc The document in which state will be stored
* @return bool True on success, False on failure
*/
bool writeXml( QDomNode & theNode, QDomDocument & theDoc ) const;
bool writeXml( QDomNode & node, QDomDocument & doc ) const;


/** Sets custom function to force valid CRS
@@ -46,7 +46,7 @@ class QgsCredentials
virtual bool requestMasterPassword( QString &password /In,Out/, bool stored = false ) = 0;

//! register instance
void setInstance( QgsCredentials *theInstance );
void setInstance( QgsCredentials *instance );

private:
QgsCredentials( const QgsCredentials& );
@@ -329,8 +329,8 @@ class QgsDataProvider : QObject
protected:

/** Add error message */
void appendError( const QgsErrorMessage & theMessage );
void appendError( const QgsErrorMessage & message );

/** Set error message */
void setError( const QgsError & theError );
void setError( const QgsError & error );
};
@@ -118,13 +118,13 @@ class QgsDataSourceUri
QString geometryColumn() const;

//! set use Estimated Metadata
void setUseEstimatedMetadata( bool theFlag );
void setUseEstimatedMetadata( bool flag );

//! Returns true if estimated metadata are used
bool useEstimatedMetadata() const;

//! Set to true to disable selection by id
void disableSelectAtId( bool theFlag );
void disableSelectAtId( bool flag );
//! Returns whether the selection by id is disabled
bool selectAtIdDisabled() const;

@@ -30,7 +30,7 @@ class QgsDatumTransformStore

void readXml( const QDomNode& parentNode );

void writeXml( QDomNode& parentNode, QDomDocument& theDoc ) const;
void writeXml( QDomNode& parentNode, QDomDocument& doc ) const;

struct Entry
{
@@ -14,13 +14,13 @@ class QgsErrorMessage
QgsErrorMessage();

/** Constructor.
* @param theMessage error message string
* @param theTag error label, for example GDAL, GDAL Provider, Raster layer
* @param theFile the file where error was created
* @param theFunction the function where error was created
* @param theLine the line where error was created
* @param message error message string
* @param tag error label, for example GDAL, GDAL Provider, Raster layer
* @param file the file where error was created
* @param function the function where error was created
* @param line the line where error was created
*/
QgsErrorMessage( const QString & theMessage, const QString & theTag = QString::null, const QString & theFile = QString::null, const QString & theFunction = QString::null, int theLine = 0 );
QgsErrorMessage( const QString & message, const QString & tag = QString::null, const QString & file = QString::null, const QString & function = QString::null, int line = 0 );

QString message() const;
QString tag() const;
@@ -44,32 +44,32 @@ class QgsError
QgsError();

/** Constructor with single message.
* @param theMessage error message
* @param theTag short description, e.g. GDAL, Provider, Layer
* @param message error message
* @param tag short description, e.g. GDAL, Provider, Layer
*/
QgsError( const QString & theMessage, const QString & theTag );
QgsError( const QString & message, const QString & tag );

/** Append new error message.
* @param theMessage error message string
* @param theTag error label, for example GDAL, GDAL Provider, Raster layer
* @param message error message string
* @param tag error label, for example GDAL, GDAL Provider, Raster layer
*/
void append( const QString & theMessage, const QString & theTag );
void append( const QString & message, const QString & tag );

/** Append new error message.
* @param theMessage error message
* @param message error message
*/
void append( const QgsErrorMessage & theMessage );
void append( const QgsErrorMessage & message );

/** Test if any error is set.
* @return true if contains error
*/
bool isEmpty() const;

/** Full error messages description
* @param theFormat output format
* @param format output format
* @return error report
*/
QString message( QgsErrorMessage::Format theFormat = QgsErrorMessage::Html ) const;
QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const;

/** Short error description, usually the first error in chain, the real error.
* @return error description
@@ -32,7 +32,7 @@ class QgsFeatureStore
QgsFeatureList& features();

/** Set map of optional parameters */
void setParams( const QMap<QString, QVariant> &theParams );
void setParams( const QMap<QString, QVariant> &params );

/** Get map of optional parameters */
QMap<QString, QVariant> params() const;
@@ -48,7 +48,7 @@ class QgsLogger
static int debugLevel();

/** Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. **/
static void logMessageToFile( const QString& theMessage );
static void logMessageToFile( const QString& message );

/** Reads the environment variable QGIS_LOG_FILE. Returns NULL if the variable is not set,
* otherwise returns a file name for writing log messages to.*/

0 comments on commit 7812d4f

Please sign in to comment.
You can’t perform that action at this time.