1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Wt: Wt::WEnvironment Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="classWt_1_1WEnvironment.html">WEnvironment</a>
</div>
</div>
<div class="contents">
<h1>Wt::WEnvironment Class Reference</h1><!-- doxytag: class="Wt::WEnvironment" -->A class that captures information on the application environment.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/WEnvironment></code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::WEnvironment:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1WEnvironment__inherit__graph.png" border="0" usemap="#Wt_1_1WEnvironment__inherit__map" alt="Inheritance graph"></center>
<map name="Wt_1_1WEnvironment__inherit__map">
<area shape="rect" href="classWt_1_1Test_1_1WTestEnvironment.html" title="An environment for testing purposes." alt="" coords="5,80,192,107"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classWt_1_1WEnvironment-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#b293698bb21313768c279dbe3a9803b6">ContentType</a> { <a class="el" href="classWt_1_1WEnvironment.html#b293698bb21313768c279dbe3a9803b62088cf5865710d6b46092a96b8505288">XHTML1</a>,
<a class="el" href="classWt_1_1WEnvironment.html#b293698bb21313768c279dbe3a9803b65370f3c22a92a80c345c545d902dc6c5">HTML4</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for HTML content type. <a href="classWt_1_1WEnvironment.html#b293698bb21313768c279dbe3a9803b6">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map< std::string, <br>
std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#163671f35f1080badcb791a826f5fadd">CookieMap</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cookie map. <a href="#163671f35f1080badcb791a826f5fadd"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="namespaceWt_1_1Http.html#3420f95c8bfecf3d46e65920c765345a">Http::ParameterMap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#c333df7571b921b4f22492c2bb95bcd4">getParameterMap</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters passed to the application. <a href="#c333df7571b921b4f22492c2bb95bcd4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="namespaceWt_1_1Http.html#e1470e15e15eab123a19e4204f624598">Http::ParameterValues</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#0c2ff76f4db12bc9ab390f7673af9b91">getParameterValues</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns values for a query parameter. <a href="#0c2ff76f4db12bc9ab390f7673af9b91"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#3f87915f10f39b18eac28bac65c0cd46">getParameter</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a single value for a query parameter. <a href="#3f87915f10f39b18eac28bac65c0cd46"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classWt_1_1WEnvironment.html#163671f35f1080badcb791a826f5fadd">CookieMap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#30810ecfa507bc6f655c38a6f218dc92">cookies</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cookies set in the initial call to the application. <a href="#30810ecfa507bc6f655c38a6f218dc92"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#f39745ca2c6c6fc00c0f78bc7d064e3a">getCookie</a> (const std::string &cookieNname) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks for existence and returns specified argument. <a href="#f39745ca2c6c6fc00c0f78bc7d064e3a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6048d608f4d7a6c2f5c74abe517d7bb0"></a><!-- doxytag: member="Wt::WEnvironment::headerValue" ref="6048d608f4d7a6c2f5c74abe517d7bb0" args="(const std::string &name) const " -->
const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#6048d608f4d7a6c2f5c74abe517d7bb0">headerValue</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a cgi environment header value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#bf06c6d85be1b482c037f80e63890f3a">supportsCookies</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the browser has enabled support for cookies. <a href="#bf06c6d85be1b482c037f80e63890f3a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#9ad466ecabd71a039cbfbee137867849">javaScript</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the browser has enabled support for JavaScript. <a href="#9ad466ecabd71a039cbfbee137867849"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#f39702064f91a549514f28de713b7cd2">ajax</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the browser has enabled support for AJAX. <a href="#f39702064f91a549514f28de713b7cd2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#06c074249363d4ef4b90bc9cbae96261">dpiScale</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the browser-side DPI scaling factor. <a href="#06c074249363d4ef4b90bc9cbae96261"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#42b10cde31c3df634dc753b5dbd1e800">locale</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the preferred language indicated in the request header. <a href="#42b10cde31c3df634dc753b5dbd1e800"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#d798f03cb67b859cc42ed2e1ced82fcd">hostName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the server host name that is used by the client. <a href="#d798f03cb67b859cc42ed2e1ced82fcd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5dd3ea667a61c3bbc2c6e1e3a879dc2f"></a><!-- doxytag: member="Wt::WEnvironment::urlScheme" ref="5dd3ea667a61c3bbc2c6e1e3a879dc2f" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#5dd3ea667a61c3bbc2c6e1e3a879dc2f">urlScheme</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the URL scheme used for the current request (<code>"http"</code> or <code>"https"</code>). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#3ac010296af1ee9dbcbfecad96dc5a0f">userAgent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the user agent. <a href="#3ac010296af1ee9dbcbfecad96dc5a0f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#a68ac8744d2dc060d6c66ab22fbadbe1">referer</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the referer. <a href="#a68ac8744d2dc060d6c66ab22fbadbe1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#9160e82a73d21aa1a0a76bf5eeeac886">accept</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the accept header. <a href="#9160e82a73d21aa1a0a76bf5eeeac886"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#be062ba13bf3df36e06d611e04b66603">agentIsSpiderBot</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if the user agent is a (known) indexing spider bot. <a href="#be062ba13bf3df36e06d611e04b66603"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#8d2c52cbf0c79d315088e56c8e5fe224">serverSignature</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the web server signature. <a href="#8d2c52cbf0c79d315088e56c8e5fe224"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#d0d4a99a818ca7cb851ef43187c9ade7">serverSoftware</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the web server software. <a href="#d0d4a99a818ca7cb851ef43187c9ade7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#a407aa90c7a3ab9ecb46de0ed9451797">serverAdmin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the email address of the server admin. <a href="#a407aa90c7a3ab9ecb46de0ed9451797"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#3cd4cc541b27cfe4f937d2b945f5ff6a">clientAddress</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the IP address of the client. <a href="#3cd4cc541b27cfe4f937d2b945f5ff6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#db17bb1f17c56f78418e06872d531c24">pathInfo</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the path info of the original request (<b>deprecated</b>). <a href="#db17bb1f17c56f78418e06872d531c24"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#cb2ba1f1f88e9cd6b7a57a2e51518ec6">internalPath</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the initial internal path. <a href="#cb2ba1f1f88e9cd6b7a57a2e51518ec6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#a6c6f66f82b2c6f08317366882d9b827">deploymentPath</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the deployment path. <a href="#a6c6f66f82b2c6f08317366882d9b827"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#bf911f096b978f4e842596c7401052de">libraryVersion</a> (int &series, int &major, int &minor) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the version of the Wt library, broken down. <a href="#bf911f096b978f4e842596c7401052de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#41d6fa0197d24e92cc463cc9d5815f10">sessionId</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the Wt session id. <a href="#41d6fa0197d24e92cc463cc9d5815f10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#3aa8ecc5ee3b7c7298ac33c43b65ec1a">getCgiValue</a> (const std::string &varName) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a raw CGI environment variable. <a href="#3aa8ecc5ee3b7c7298ac33c43b65ec1a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWt_1_1WEnvironment.html#b293698bb21313768c279dbe3a9803b6">ContentType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#375dfdc05e69eb22b8b644d2fada4d41">contentType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The type of the content provided to the browser. <a href="#375dfdc05e69eb22b8b644d2fada4d41"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WEnvironment.html#8d55627d202b6d8866c7703a6e9dddf1">libraryVersion</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the version of the Wt library. <a href="#8d55627d202b6d8866c7703a6e9dddf1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class that captures information on the application environment.
<p>
The environment provides information on the client, and gives access to startup arguments.<p>
Usage example:<p>
<div class="fragment"><pre class="fragment"> <span class="keyword">const</span> WEnvironment& env = <a class="code" href="classWt_1_1WApplication.html#38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">WApplication::instance</a>()->environment();
<span class="comment">// read an application startup argument </span>
<span class="comment">// (passed as argument in the URL or POST'ed to the application).</span>
<span class="keywordflow">if</span> (!env.getParameterValues(<span class="stringliteral">"login"</span>).empty()) {
std::string login = env.getParameterValues(<span class="stringliteral">"login"</span>)[0];
...
}
<span class="comment">// Check for JavaScript/AJAX availability before using AJAX-only</span>
<span class="comment">// widgets</span>
<a class="code" href="classWt_1_1WTextArea.html" title="A widget that provides a multi-line edit.">Wt::WTextArea</a> *textEdit;
<span class="keywordflow">if</span> (!env.ajax())
textEdit = <span class="keyword">new</span> <a class="code" href="classWt_1_1WTextEdit.html" title="A rich-text XHTML editor.">Wt::WTextEdit</a>(); <span class="comment">// provide an HTML text editor</span>
<span class="keywordflow">else</span>
textEdit = <span class="keyword">new</span> <a class="code" href="classWt_1_1WTextArea.html" title="A widget that provides a multi-line edit.">Wt::WTextArea</a>(); <span class="comment">// fall-back to a plain old text area.</span>
</pre></div> <hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="163671f35f1080badcb791a826f5fadd"></a><!-- doxytag: member="Wt::WEnvironment::CookieMap" ref="163671f35f1080badcb791a826f5fadd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::map<std::string, std::string> <a class="el" href="classWt_1_1WEnvironment.html#163671f35f1080badcb791a826f5fadd">Wt::WEnvironment::CookieMap</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cookie map.
<p>
A std::map which associates a cookie name with a cookie value.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#30810ecfa507bc6f655c38a6f218dc92" title="Cookies set in the initial call to the application.">cookies()</a> </dd></dl>
</div>
</div><p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="b293698bb21313768c279dbe3a9803b6"></a><!-- doxytag: member="Wt::WEnvironment::ContentType" ref="b293698bb21313768c279dbe3a9803b6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WEnvironment.html#b293698bb21313768c279dbe3a9803b6">Wt::WEnvironment::ContentType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enumeration for HTML content type.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="b293698bb21313768c279dbe3a9803b62088cf5865710d6b46092a96b8505288"></a><!-- doxytag: member="XHTML1" ref="b293698bb21313768c279dbe3a9803b62088cf5865710d6b46092a96b8505288" args="" -->XHTML1</em> </td><td>
XHTML1.x. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="b293698bb21313768c279dbe3a9803b65370f3c22a92a80c345c545d902dc6c5"></a><!-- doxytag: member="HTML4" ref="b293698bb21313768c279dbe3a9803b65370f3c22a92a80c345c545d902dc6c5" args="" -->HTML4</em> </td><td>
HTML4. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c333df7571b921b4f22492c2bb95bcd4"></a><!-- doxytag: member="Wt::WEnvironment::getParameterMap" ref="c333df7571b921b4f22492c2bb95bcd4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceWt_1_1Http.html#3420f95c8bfecf3d46e65920c765345a">Http::ParameterMap</a>& Wt::WEnvironment::getParameterMap </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parameters passed to the application.
<p>
Arguments passed to the application, either in the URL for a http GET, or in both the URL and data submitted in a http POST.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#0c2ff76f4db12bc9ab390f7673af9b91" title="Returns values for a query parameter.">getParameterValues()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="0c2ff76f4db12bc9ab390f7673af9b91"></a><!-- doxytag: member="Wt::WEnvironment::getParameterValues" ref="0c2ff76f4db12bc9ab390f7673af9b91" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceWt_1_1Http.html#e1470e15e15eab123a19e4204f624598">Http::ParameterValues</a> & Wt::WEnvironment::getParameterValues </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns values for a query parameter.
<p>
Returns an empty list if the parameter was not defined.<p>
One or more values may be associated with a single argument.<p>
For example a Wt application <code>foo.wt</code> started as <code><a href="http://.../foo.wt?hello=Hello&hello=World">http://.../foo.wt?hello=Hello&hello=World</a></code> will result in both values <code>"Hello"</code> and <code>"World"</code> to be associated with the argument <code>"hello"</code>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#c333df7571b921b4f22492c2bb95bcd4" title="Parameters passed to the application.">getParameterMap()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="3f87915f10f39b18eac28bac65c0cd46"></a><!-- doxytag: member="Wt::WEnvironment::getParameter" ref="3f87915f10f39b18eac28bac65c0cd46" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string * Wt::WEnvironment::getParameter </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a single value for a query parameter.
<p>
Returns the first value for a parameter, or <code>0</code> if the parameter is not found.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#0c2ff76f4db12bc9ab390f7673af9b91" title="Returns values for a query parameter.">getParameterValues()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="30810ecfa507bc6f655c38a6f218dc92"></a><!-- doxytag: member="Wt::WEnvironment::cookies" ref="30810ecfa507bc6f655c38a6f218dc92" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WEnvironment.html#163671f35f1080badcb791a826f5fadd">CookieMap</a>& Wt::WEnvironment::cookies </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cookies set in the initial call to the application.
<p>
Note that cookies set with <a class="el" href="classWt_1_1WApplication.html#0aa2703da36531cf1773d3e756791bf6" title="Sets a new cookie.">WApplication::setCookie()</a> are not made available in the environment.<p>
Not all clients may support cookies or have cookies enabled.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#bf06c6d85be1b482c037f80e63890f3a" title="Returns whether the browser has enabled support for cookies.">supportsCookies()</a>, <a class="el" href="classWt_1_1WEnvironment.html#f39745ca2c6c6fc00c0f78bc7d064e3a" title="Checks for existence and returns specified argument.">getCookie()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f39745ca2c6c6fc00c0f78bc7d064e3a"></a><!-- doxytag: member="Wt::WEnvironment::getCookie" ref="f39745ca2c6c6fc00c0f78bc7d064e3a" args="(const std::string &cookieNname) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string Wt::WEnvironment::getCookie </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>cookieNname</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks for existence and returns specified argument.
<p>
Throws a <code>std::runtime_error("Missing cookie: ...")</code> when the cookie is missing, or returns cookie value otherwise.
</div>
</div><p>
<a class="anchor" name="bf06c6d85be1b482c037f80e63890f3a"></a><!-- doxytag: member="Wt::WEnvironment::supportsCookies" ref="bf06c6d85be1b482c037f80e63890f3a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WEnvironment::supportsCookies </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether the browser has enabled support for cookies.
<p>
When the user disables cookies during the visit of the page, this value is not updated.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#30810ecfa507bc6f655c38a6f218dc92" title="Cookies set in the initial call to the application.">cookies()</a>, <a class="el" href="classWt_1_1WEnvironment.html#f39745ca2c6c6fc00c0f78bc7d064e3a" title="Checks for existence and returns specified argument.">getCookie()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9ad466ecabd71a039cbfbee137867849"></a><!-- doxytag: member="Wt::WEnvironment::javaScript" ref="9ad466ecabd71a039cbfbee137867849" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WEnvironment::javaScript </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether the browser has enabled support for JavaScript.
<p>
This is the same as <a class="el" href="classWt_1_1WEnvironment.html#f39702064f91a549514f28de713b7cd2" title="Returns whether the browser has enabled support for AJAX.">ajax()</a>: Wt only considers using JavaScript when it has detected AJAX support.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#f39702064f91a549514f28de713b7cd2" title="Returns whether the browser has enabled support for AJAX.">ajax()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f39702064f91a549514f28de713b7cd2"></a><!-- doxytag: member="Wt::WEnvironment::ajax" ref="f39702064f91a549514f28de713b7cd2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WEnvironment::ajax </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether the browser has enabled support for AJAX.
<p>
Without support for JavaScript/AJAX, Wt will still be able to serve the application, but with one considerable limitation: only the <a class="el" href="classWt_1_1WTimer.html#2a66c6a51df2b0ab42258abf2ebd0399" title="Signal emitted when the timer timeouts.">WTimer::timeout()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#e11e050cce0d4a8f742afa3ef92bfe8c" title="Event signal emitted when a mouse key was clicked on this widget.">WInteractWidget::clicked()</a>, <a class="el" href="classWt_1_1WApplication.html#3e68c4b6bb387f27a614e7962e11967b" title="Signal which indicates that the user changes the internal path.">WApplication::internalPathChanged()</a>, and <a class="el" href="classWt_1_1WAbstractArea.html#cc47a02510ddcc77db551fa51e1479bf" title="Event signal emitted when a mouse key was clicked on this widget.">WAbstractArea::clicked()</a> signals (and any derived signals) will generate events.<p>
Every event will cause the complete page to be rerendered.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#9ad466ecabd71a039cbfbee137867849" title="Returns whether the browser has enabled support for JavaScript.">javaScript()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="06c074249363d4ef4b90bc9cbae96261"></a><!-- doxytag: member="Wt::WEnvironment::dpiScale" ref="06c074249363d4ef4b90bc9cbae96261" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Wt::WEnvironment::dpiScale </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the browser-side DPI scaling factor.
<p>
Internet Explorer scales all graphics, fonts and other elements on high-density screens to make them readable. This is controlled by the DPI setting of the display. If all goes well, you do not have to worry about this scaling factor. Unfortunately, not all elements are scaled appropriately. The scaling factor is supposed to be used only internally in Wt and is in this interface for informational purposes.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WVmlImage.html" title="A paint device for rendering using the VML pseudo-standard.">WVmlImage</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="42b10cde31c3df634dc753b5dbd1e800"></a><!-- doxytag: member="Wt::WEnvironment::locale" ref="42b10cde31c3df634dc753b5dbd1e800" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::locale </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the preferred language indicated in the request header.
<p>
The language is parsed from the HTTP <code>Accept-Language</code> field, if present. If not, the locale is empty.<p>
If multiple languages are present, the one with the highest "q"uality is assumed, and if a tie is present, the first one is taken.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#5c9cc1350019d69f154a2b44cdaf2596" title="Changes the locale.">WApplication::setLocale()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="d798f03cb67b859cc42ed2e1ced82fcd"></a><!-- doxytag: member="Wt::WEnvironment::hostName" ref="d798f03cb67b859cc42ed2e1ced82fcd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::hostName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the server host name that is used by the client.
<p>
The hostname is the unresolved host name with optional port number, which the browser used to connect to the application.<p>
Examples:<ul>
<li><code>www.mydomain.com</code></li><li><code>localhost:8080</code></li></ul>
<p>
For HTTP 1.1 requests, this information is fetched from the HTTP <code>Host</code> header. If Wt is configured behind a reverse proxy, then the last entry in the HTTP <code>X-Forwarded-Host</code> header field is used instead (to infer the name of the reverse proxy instead).<p>
For HTTP 1.0 requests, the HTTP <code>Host</code> header is not required. When not present, the server host name is inferred from the configured server name, which defaults to the DNS name.
</div>
</div><p>
<a class="anchor" name="3ac010296af1ee9dbcbfecad96dc5a0f"></a><!-- doxytag: member="Wt::WEnvironment::userAgent" ref="3ac010296af1ee9dbcbfecad96dc5a0f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::userAgent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the user agent.
<p>
The user agent, as reported in the HTTP <code>User-Agent</code> field.
</div>
</div><p>
<a class="anchor" name="a68ac8744d2dc060d6c66ab22fbadbe1"></a><!-- doxytag: member="Wt::WEnvironment::referer" ref="a68ac8744d2dc060d6c66ab22fbadbe1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::referer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the referer.
<p>
The referer, as reported in the HTTP <code>Referer</code> field.
</div>
</div><p>
<a class="anchor" name="9160e82a73d21aa1a0a76bf5eeeac886"></a><!-- doxytag: member="Wt::WEnvironment::accept" ref="9160e82a73d21aa1a0a76bf5eeeac886" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::accept </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the accept header.
<p>
The accept header, as reported in the HTTP <code>Accept</code> field.
</div>
</div><p>
<a class="anchor" name="be062ba13bf3df36e06d611e04b66603"></a><!-- doxytag: member="Wt::WEnvironment::agentIsSpiderBot" ref="be062ba13bf3df36e06d611e04b66603" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WEnvironment::agentIsSpiderBot </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns if the user agent is a (known) indexing spider bot.
<p>
Note: currently the list of know bots is quite small. This method is used internally to render the web application for optimal indexing by bots:<ul>
<li>there is no detection for JavaScript, instead the application is directly served assuming no JavaScript support.</li><li>session information is omitted from the Urls.</li><li>no sessions are created (they are immediately stopped after the request has been handled).</li><li>auto-generated <code>id</code> and <code>name</code> attributes are omitted from DOM nodes. In this way, the generated page is always exactly the same. </li></ul>
</div>
</div><p>
<a class="anchor" name="8d2c52cbf0c79d315088e56c8e5fe224"></a><!-- doxytag: member="Wt::WEnvironment::serverSignature" ref="8d2c52cbf0c79d315088e56c8e5fe224" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::serverSignature </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the web server signature.
<p>
The value of the CGI variable <code>SERVER_SIGNATURE</code>.<p>
Example: <code><address>Apache Server at localhost Port 80</address></code>.
</div>
</div><p>
<a class="anchor" name="d0d4a99a818ca7cb851ef43187c9ade7"></a><!-- doxytag: member="Wt::WEnvironment::serverSoftware" ref="d0d4a99a818ca7cb851ef43187c9ade7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::serverSoftware </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the web server software.
<p>
The value of the CGI variable <code>SERVER_SOFTWARE</code>.<p>
Example: <code>"Apache"</code>
</div>
</div><p>
<a class="anchor" name="a407aa90c7a3ab9ecb46de0ed9451797"></a><!-- doxytag: member="Wt::WEnvironment::serverAdmin" ref="a407aa90c7a3ab9ecb46de0ed9451797" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::serverAdmin </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the email address of the server admin.
<p>
The value of the CGI variable <code>SERVER_ADMIN</code>.<p>
Example: <code>"root@localhost"</code>
</div>
</div><p>
<a class="anchor" name="3cd4cc541b27cfe4f937d2b945f5ff6a"></a><!-- doxytag: member="Wt::WEnvironment::clientAddress" ref="3cd4cc541b27cfe4f937d2b945f5ff6a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::clientAddress </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the IP address of the client.
<p>
The (most likely) IP address of the client that is connected to this session.<p>
This is taken to be the first public address that is given in the Client-IP header, or in the X-Forwarded-For header (in case the client is behind a proxy). If none of these headers is present, the remote socket IP address is used.
</div>
</div><p>
<a class="anchor" name="db17bb1f17c56f78418e06872d531c24"></a><!-- doxytag: member="Wt::WEnvironment::pathInfo" ref="db17bb1f17c56f78418e06872d531c24" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::pathInfo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the path info of the original request (<b>deprecated</b>).
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WEnvironment.html#cb2ba1f1f88e9cd6b7a57a2e51518ec6" title="Returns the initial internal path.">internalPath()</a> instead, which is consistent with the internal paths generated by Wt.</dd></dl>
This is the equivalent of the CGI PATH_INFO environment variable.<p>
Assume for example that the application was deployed at <code>"stuff/app.wt"</code>. When the user accesses the application using the URL <code>"http://www.mydomain.com/stuff/app.wt"</code>, this method would return an empty string (<code>""</code>). When the user accesses the site using <code>"http://www.mydomain.com/stuff/app.wt/this/there"</code>, the result would be <code>"/this/there"</code>.<p>
Together with <a class="el" href="classWt_1_1WEnvironment.html#3f87915f10f39b18eac28bac65c0cd46" title="Returns a single value for a query parameter.">getParameter()</a>, this allows you to supply the application with initial information.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#3f87915f10f39b18eac28bac65c0cd46" title="Returns a single value for a query parameter.">getParameter()</a>, <a class="el" href="classWt_1_1WEnvironment.html#cb2ba1f1f88e9cd6b7a57a2e51518ec6" title="Returns the initial internal path.">internalPath()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="cb2ba1f1f88e9cd6b7a57a2e51518ec6"></a><!-- doxytag: member="Wt::WEnvironment::internalPath" ref="cb2ba1f1f88e9cd6b7a57a2e51518ec6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::WEnvironment::internalPath </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the initial internal path.
<p>
This is the internal path with which the application was started.<p>
For an application deployed at <code>"/stuff/app.wt"</code>, the following three URLs are considered equivalent, and indicate an internal path <code>"/this/there"</code>: <div class="fragment"><pre class="fragment"> http:<span class="comment">//www.mydomain.com/stuff/app.wt/this/there</span>
http:<span class="comment">//www.mydomain.com/stuff/app.wt#/this/there</span>
http:<span class="comment">//www.mydomain.com/stuff/app.wt?_=/this/there</span>
</pre></div><p>
The last form is generated by Wt when the application ends with a '/', as an alternative to the first form, which is then impossible.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#2c1a10aadc0d7ed877b5715b42ca4911" title="Change the internal path.">WApplication::setInternalPath()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a6c6f66f82b2c6f08317366882d9b827" title="Returns the deployment path.">deploymentPath()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="a6c6f66f82b2c6f08317366882d9b827"></a><!-- doxytag: member="Wt::WEnvironment::deploymentPath" ref="a6c6f66f82b2c6f08317366882d9b827" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string & Wt::WEnvironment::deploymentPath </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the deployment path.
<p>
This is the path at which the application is deployed.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#cb2ba1f1f88e9cd6b7a57a2e51518ec6" title="Returns the initial internal path.">internalPath()</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8d55627d202b6d8866c7703a6e9dddf1"></a><!-- doxytag: member="Wt::WEnvironment::libraryVersion" ref="8d55627d202b6d8866c7703a6e9dddf1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WEnvironment::libraryVersion </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the version of the Wt library.
<p>
Example: <code>"1.99.2"</code>
</div>
</div><p>
<a class="anchor" name="bf911f096b978f4e842596c7401052de"></a><!-- doxytag: member="Wt::WEnvironment::libraryVersion" ref="bf911f096b978f4e842596c7401052de" args="(int &series, int &major, int &minor) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WEnvironment::libraryVersion </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>series</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>major</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>minor</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the version of the Wt library, broken down.
<p>
The version of the Wt library, broken down in its three numbers,<p>
Example: <em>series</em> = 1, <em>major</em> = 99, <code>minor</code> = 2.
</div>
</div><p>
<a class="anchor" name="41d6fa0197d24e92cc463cc9d5815f10"></a><!-- doxytag: member="Wt::WEnvironment::sessionId" ref="41d6fa0197d24e92cc463cc9d5815f10" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WEnvironment::sessionId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the Wt session id.
<p>
Retrieves the session id for this session. This is an auto-generated random alpha-numerical id, whose length is determined by settings in the configuration file.
</div>
</div><p>
<a class="anchor" name="3aa8ecc5ee3b7c7298ac33c43b65ec1a"></a><!-- doxytag: member="Wt::WEnvironment::getCgiValue" ref="3aa8ecc5ee3b7c7298ac33c43b65ec1a" args="(const std::string &varName) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WEnvironment::getCgiValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>varName</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a raw CGI environment variable.
<p>
Retrieves the value for the given CGI environment variable (like <code>"SSL_CLIENT_S_DN_CN"</code>), if it is defined, otherwise an empty string.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WEnvironment.html#8d2c52cbf0c79d315088e56c8e5fe224" title="Returns the web server signature.">serverSignature()</a>, <a class="el" href="classWt_1_1WEnvironment.html#d0d4a99a818ca7cb851ef43187c9ade7" title="Returns the web server software.">serverSoftware()</a>, <a class="el" href="classWt_1_1WEnvironment.html#a407aa90c7a3ab9ecb46de0ed9451797" title="Returns the email address of the server admin.">serverAdmin()</a>, </dd></dl>
</div>
</div><p>
<a class="anchor" name="375dfdc05e69eb22b8b644d2fada4d41"></a><!-- doxytag: member="Wt::WEnvironment::contentType" ref="375dfdc05e69eb22b8b644d2fada4d41" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WEnvironment.html#b293698bb21313768c279dbe3a9803b6">ContentType</a> Wt::WEnvironment::contentType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The type of the content provided to the browser.
<p>
This is determined by listening to the capabilities of the browser. Xhtml1 is chosen only if the browser reports support for it, and it is allowed in the configuration file (wt_config.xml).<p>
Note that Wt makes also use of common non-standard techniques implemented in every major browser.
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:06 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>
|
