QGIS API Documentation  2.10.1-Pisa
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsServerInterface Class Referenceabstract

QgsServerInterface Class defining interfaces exposed by Qgis Mapserver and made available to plugins. More...

#include <qgsserverinterface.h>

Public Member Functions

 QgsServerInterface ()
 Constructor. More...
 
virtual ~QgsServerInterface ()=0
 Destructor. More...
 
virtual QgsCapabilitiesCachecapabiblitiesCache ()=0
 Get pointer to the capabiblities cache. More...
 
virtual QgsServerFiltersMap filters ()=0
 Return the list of current QgsServerFilter. More...
 
virtual QString getEnv (const QString &name) const =0
 Return an enrironment variable, used to pass environment variables to python. More...
 
virtual void registerFilter (QgsServerFilter *filter, int priority=0)=0
 Register a QgsServerFilter. More...
 
virtual QgsRequestHandlerrequestHandler ()=0
 Get pointer to the request handler. More...
 
virtual void setRequestHandler (QgsRequestHandler *requestHandler)=0
 Set the request handler. More...
 

Detailed Description

QgsServerInterface Class defining interfaces exposed by Qgis Mapserver and made available to plugins.

Definition at line 33 of file qgsserverinterface.h.

Constructor & Destructor Documentation

QgsServerInterface::QgsServerInterface ( )

Constructor.

virtual QgsServerInterface::~QgsServerInterface ( )
pure virtual

Destructor.

Member Function Documentation

virtual QgsCapabilitiesCache* QgsServerInterface::capabiblitiesCache ( )
pure virtual

Get pointer to the capabiblities cache.

Returns
QgsCapabilitiesCache
virtual QgsServerFiltersMap QgsServerInterface::filters ( )
pure virtual

Return the list of current QgsServerFilter.

Returns
QgsServerFiltersMap list of QgsServerFilter
virtual QString QgsServerInterface::getEnv ( const QString name) const
pure virtual

Return an enrironment variable, used to pass environment variables to python.

virtual void QgsServerInterface::registerFilter ( QgsServerFilter filter,
int  priority = 0 
)
pure virtual

Register a QgsServerFilter.

Parameters
filterthe QgsServerFilter to add
priorityan optional priority for the filter order
virtual QgsRequestHandler* QgsServerInterface::requestHandler ( )
pure virtual

Get pointer to the request handler.

Returns
QgsRequestHandler
virtual void QgsServerInterface::setRequestHandler ( QgsRequestHandler requestHandler)
pure virtual

Set the request handler.

Parameters
requestHandlerrequest handler

The documentation for this class was generated from the following file: