QGIS API Documentation
3.43.0-Master (fa3a2ef2f67)
Loading...
Searching...
No Matches
src
server
qgsserverapicontext.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsserverapicontext.h - QgsServerApiContext
3
4
---------------------
5
begin : 13.5.2019
6
copyright : (C) 2019 by Alessandro Pasotti
7
email : elpaso at itopen dot it
8
***************************************************************************
9
* *
10
* This program is free software; you can redistribute it and/or modify *
11
* it under the terms of the GNU General Public License as published by *
12
* the Free Software Foundation; either version 2 of the License, or *
13
* (at your option) any later version. *
14
* *
15
***************************************************************************/
16
#ifndef QGSSERVERAPICONTEXT_H
17
#define QGSSERVERAPICONTEXT_H
18
19
#include "qgis_server.h"
20
#include <QString>
21
22
class
QgsServerResponse
;
23
class
QgsServerRequest
;
24
class
QgsServerInterface
;
25
class
QgsProject
;
26
39
class
SERVER_EXPORT
QgsServerApiContext
40
{
41
public
:
52
QgsServerApiContext
(
const
QString &apiRootPath,
const
QgsServerRequest
*request,
QgsServerResponse
*response,
const
QgsProject
*project,
QgsServerInterface
*serverInterface );
53
57
const
QgsServerRequest
*request()
const
;
58
62
QgsServerResponse
*response()
const
;
63
68
const
QgsProject
*project()
const
;
69
74
void
setProject(
const
QgsProject
*project );
75
79
QgsServerInterface
*serverInterface()
const
;
80
91
const
QString matchedPath()
const
;
92
96
QString apiRootPath()
const
;
97
101
void
setRequest(
const
QgsServerRequest
*request );
102
109
QString handlerPath()
const
;
110
111
private
:
112
QString mApiRootPath;
113
const
QgsServerRequest
*mRequest =
nullptr
;
114
QgsServerResponse
*mResponse =
nullptr
;
115
const
QgsProject
*mProject =
nullptr
;
116
QgsServerInterface
*mServerInterface =
nullptr
;
117
};
118
119
#endif
// QGSSERVERAPICONTEXT_H
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition
qgsproject.h:107
QgsServerApiContext
Encapsulates the resources for a particular client request.
Definition
qgsserverapicontext.h:40
QgsServerInterface
Defines interfaces exposed by QGIS Server and made available to plugins.
Definition
qgsserverinterface.h:59
QgsServerRequest
Defines requests passed to QgsService classes.
Definition
qgsserverrequest.h:35
QgsServerResponse
Defines the response interface passed to QgsService.
Definition
qgsserverresponse.h:42
Generated on Thu Apr 17 2025 12:14:43 for QGIS API Documentation by
1.9.8