1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class GeSHi</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
11 <div class="page-body">
12 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
15 style="vertical-align: middle"> GeSHi</h2>
17 <a name="sec-description"></a>
18 <div class="info-box">
19 <div class="info-box-title">Description</div>
21 <span class="disabled">Description</span> |
22 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">The GeSHi Class.</p>
28 <p class="description"><p>Please refer to the documentation for GeSHi 1.0.X that is available at http://qbnz.com/highlighter/documentation.php for more information about how to use this class.</p></p>
30 <li><span class="field">author:</span> Nigel McNie <<a href="mailto:nigel@geshi.org">nigel@geshi.org</a>>, Benny Baumann <BenBE@omorphia.de></li>
31 <li><span class="field">copyright:</span> (C) 2004 - 2007 Nigel McNie, (C) 2007 - 2008 Benny Baumann</li>
34 Located in <a class="field" href="_geshi.php.html">/geshi.php</a> (line <span class="field"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a253">253</a></span>)
46 <a name="sec-method-summary"></a>
47 <div class="info-box">
48 <div class="info-box-title">Method Summary</span></div>
50 <a href="#sec-description">Description</a> |
51 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
53 <div class="info-box-body">
54 <div class="method-summary">
55 <div class="method-definition">
56 <img src="../../media/images/Constructor.png" alt=" "/>
57 <span class="method-result">GeSHi</span>
58 <a href="#GeSHi" title="details" class="method-name">GeSHi</a>
59 ([<span class="var-type">string</span> <span class="var-name">$source</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$language</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$path</span> = <span class="var-default">''</span>])
61 <div class="method-definition">
62 <img src="../../media/images/Method.png" alt=" "/>
63 <span class="method-result">void</span>
64 <a href="#add_keyword" title="details" class="method-name">add_keyword</a>
65 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$word</span>)
67 <div class="method-definition">
68 <img src="../../media/images/Method.png" alt=" "/>
69 <span class="method-result">void</span>
70 <a href="#add_keyword_group" title="details" class="method-name">add_keyword_group</a>
71 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$styles</span>, [<span class="var-type">boolean</span> <span class="var-name">$case_sensitive</span> = <span class="var-default">true</span>], [<span class="var-type">array</span> <span class="var-name">$words</span> = <span class="var-default">array()</span>])
73 <div class="method-definition">
74 <img src="../../media/images/Method.png" alt=" "/>
75 <span class="method-result">void</span>
76 <a href="#disable_highlighting" title="details" class="method-name">disable_highlighting</a>
79 <div class="method-definition">
80 <img src="../../media/images/Method.png" alt=" "/>
81 <span class="method-result">void</span>
82 <a href="#enable_classes" title="details" class="method-name">enable_classes</a>
83 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
85 <div class="method-definition">
86 <img src="../../media/images/Method.png" alt=" "/>
87 <span class="method-result">void</span>
88 <a href="#enable_highlighting" title="details" class="method-name">enable_highlighting</a>
89 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
91 <div class="method-definition">
92 <img src="../../media/images/Method.png" alt=" "/>
93 <span class="method-result">void</span>
94 <a href="#enable_ids" title="details" class="method-name">enable_ids</a>
95 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
97 <div class="method-definition">
98 <img src="../../media/images/Method.png" alt=" "/>
99 <span class="method-result">void</span>
100 <a href="#enable_important_blocks" title="details" class="method-name">enable_important_blocks</a>
101 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
103 <div class="method-definition">
104 <img src="../../media/images/Method.png" alt=" "/>
105 <span class="method-result">void</span>
106 <a href="#enable_inner_code_block" title="details" class="method-name">enable_inner_code_block</a>
107 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
109 <div class="method-definition">
110 <img src="../../media/images/Method.png" alt=" "/>
111 <span class="method-result">void</span>
112 <a href="#enable_keyword_links" title="details" class="method-name">enable_keyword_links</a>
113 ([<span class="var-type">boolean</span> <span class="var-name">$enable</span> = <span class="var-default">true</span>])
115 <div class="method-definition">
116 <img src="../../media/images/Method.png" alt=" "/>
117 <span class="method-result">void</span>
118 <a href="#enable_line_numbers" title="details" class="method-name">enable_line_numbers</a>
119 (<span class="var-type">int</span> <span class="var-name">$flag</span>, [<span class="var-type">int</span> <span class="var-name">$nth_row</span> = <span class="var-default">5</span>])
121 <div class="method-definition">
122 <img src="../../media/images/Method.png" alt=" "/>
123 <span class="method-result">void</span>
124 <a href="#enable_multiline_span" title="details" class="method-name">enable_multiline_span</a>
125 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
127 <div class="method-definition">
128 <img src="../../media/images/Method.png" alt=" "/>
129 <span class="method-result">void</span>
130 <a href="#enable_strict_mode" title="details" class="method-name">enable_strict_mode</a>
131 ([<span class="var-type">boolean</span> <span class="var-name">$mode</span> = <span class="var-default">true</span>])
133 <div class="method-definition">
134 <img src="../../media/images/Method.png" alt=" "/>
135 <span class="method-result">string|false</span>
136 <a href="#error" title="details" class="method-name">error</a>
139 <div class="method-definition">
140 <img src="../../media/images/Method.png" alt=" "/>
141 <span class="method-result">string</span>
142 <a href="#get_language_name" title="details" class="method-name">get_language_name</a>
145 <div class="method-definition">
146 <img src="../../media/images/Method.png" alt=" "/>
147 <span class="method-result">void</span>
148 <a href="#get_language_name_from_extension" title="details" class="method-name">get_language_name_from_extension</a>
149 (<span class="var-type">string</span> <span class="var-name">$extension</span>, [<span class="var-type">array</span> <span class="var-name">$lookup</span> = <span class="var-default">array()</span>])
151 <div class="method-definition">
152 <img src="../../media/images/Method.png" alt=" "/>
153 <span class="method-result">bool</span>
154 <a href="#get_multiline_span" title="details" class="method-name">get_multiline_span</a>
157 <div class="method-definition">
158 <img src="../../media/images/Method.png" alt=" "/>
159 <span class="method-result">int</span>
160 <a href="#get_real_tab_width" title="details" class="method-name">get_real_tab_width</a>
163 <div class="method-definition">
164 <img src="../../media/images/Method.png" alt=" "/>
165 <span class="method-result">string</span>
166 <a href="#get_stylesheet" title="details" class="method-name">get_stylesheet</a>
167 ([<span class="var-type">boolean</span> <span class="var-name">$economy_mode</span> = <span class="var-default">true</span>])
169 <div class="method-definition">
170 <img src="../../media/images/Method.png" alt=" "/>
171 <span class="method-result">double</span>
172 <a href="#get_time" title="details" class="method-name">get_time</a>
175 <div class="method-definition">
176 <img src="../../media/images/Method.png" alt=" "/>
177 <span class="method-result">void</span>
178 <a href="#highlight_lines_extra" title="details" class="method-name">highlight_lines_extra</a>
179 (<span class="var-type">mixed</span> <span class="var-name">$lines</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">null</span>])
181 <div class="method-definition">
182 <img src="../../media/images/Method.png" alt=" "/>
183 <span class="method-result">void</span>
184 <a href="#load_from_file" title="details" class="method-name">load_from_file</a>
185 (<span class="var-type">string</span> <span class="var-name">$file_name</span>, [<span class="var-type">array</span> <span class="var-name">$lookup</span> = <span class="var-default">array()</span>])
187 <div class="method-definition">
188 <img src="../../media/images/Method.png" alt=" "/>
189 <span class="method-result">void</span>
190 <a href="#optimize_keyword_group" title="details" class="method-name">optimize_keyword_group</a>
191 (<span class="var-type">int</span> <span class="var-name">$key</span>)
193 <div class="method-definition">
194 <img src="../../media/images/Method.png" alt=" "/>
195 <span class="method-result">void</span>
196 <a href="#parse_code" title="details" class="method-name">parse_code</a>
199 <div class="method-definition">
200 <img src="../../media/images/Method.png" alt=" "/>
201 <span class="method-result">void</span>
202 <a href="#remove_keyword" title="details" class="method-name">remove_keyword</a>
203 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$word</span>, [<span class="var-type">bool</span> <span class="var-name">$recompile</span> = <span class="var-default">true</span>])
205 <div class="method-definition">
206 <img src="../../media/images/Method.png" alt=" "/>
207 <span class="method-result">void</span>
208 <a href="#remove_keyword_group" title="details" class="method-name">remove_keyword_group</a>
209 (<span class="var-type">int</span> <span class="var-name">$key</span>)
211 <div class="method-definition">
212 <img src="../../media/images/Method.png" alt=" "/>
213 <span class="method-result">void</span>
214 <a href="#set_brackets_highlighting" title="details" class="method-name">set_brackets_highlighting</a>
215 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
217 <div class="method-definition">
218 <img src="../../media/images/Method.png" alt=" "/>
219 <span class="method-result">void</span>
220 <a href="#set_brackets_style" title="details" class="method-name">set_brackets_style</a>
221 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
223 <div class="method-definition">
224 <img src="../../media/images/Method.png" alt=" "/>
225 <span class="method-result">void</span>
226 <a href="#set_case_keywords" title="details" class="method-name">set_case_keywords</a>
227 (<span class="var-type">int</span> <span class="var-name">$case</span>)
229 <div class="method-definition">
230 <img src="../../media/images/Method.png" alt=" "/>
231 <span class="method-result">void</span>
232 <a href="#set_case_sensitivity" title="details" class="method-name">set_case_sensitivity</a>
233 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">boolean</span> <span class="var-name">$case</span>)
235 <div class="method-definition">
236 <img src="../../media/images/Method.png" alt=" "/>
237 <span class="method-result">void</span>
238 <a href="#set_code_style" title="details" class="method-name">set_code_style</a>
239 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
241 <div class="method-definition">
242 <img src="../../media/images/Method.png" alt=" "/>
243 <span class="method-result">void</span>
244 <a href="#set_comments_highlighting" title="details" class="method-name">set_comments_highlighting</a>
245 (<span class="var-type">int</span> <span class="var-name">$key</span>, [<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
247 <div class="method-definition">
248 <img src="../../media/images/Method.png" alt=" "/>
249 <span class="method-result">void</span>
250 <a href="#set_comments_style" title="details" class="method-name">set_comments_style</a>
251 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
253 <div class="method-definition">
254 <img src="../../media/images/Method.png" alt=" "/>
255 <span class="method-result">void</span>
256 <a href="#set_encoding" title="details" class="method-name">set_encoding</a>
257 (<span class="var-type">string</span> <span class="var-name">$encoding</span>)
259 <div class="method-definition">
260 <img src="../../media/images/Method.png" alt=" "/>
261 <span class="method-result">void</span>
262 <a href="#set_escape_characters_highlighting" title="details" class="method-name">set_escape_characters_highlighting</a>
263 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
265 <div class="method-definition">
266 <img src="../../media/images/Method.png" alt=" "/>
267 <span class="method-result">void</span>
268 <a href="#set_escape_characters_style" title="details" class="method-name">set_escape_characters_style</a>
269 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
271 <div class="method-definition">
272 <img src="../../media/images/Method.png" alt=" "/>
273 <span class="method-result">void</span>
274 <a href="#set_footer_content" title="details" class="method-name">set_footer_content</a>
275 (<span class="var-type">string</span> <span class="var-name">$content</span>)
277 <div class="method-definition">
278 <img src="../../media/images/Method.png" alt=" "/>
279 <span class="method-result">void</span>
280 <a href="#set_footer_content_style" title="details" class="method-name">set_footer_content_style</a>
281 (<span class="var-type">string</span> <span class="var-name">$style</span>)
283 <div class="method-definition">
284 <img src="../../media/images/Method.png" alt=" "/>
285 <span class="method-result">void</span>
286 <a href="#set_header_content" title="details" class="method-name">set_header_content</a>
287 (<span class="var-type">string</span> <span class="var-name">$content</span>)
289 <div class="method-definition">
290 <img src="../../media/images/Method.png" alt=" "/>
291 <span class="method-result">void</span>
292 <a href="#set_header_content_style" title="details" class="method-name">set_header_content_style</a>
293 (<span class="var-type">string</span> <span class="var-name">$style</span>)
295 <div class="method-definition">
296 <img src="../../media/images/Method.png" alt=" "/>
297 <span class="method-result">void</span>
298 <a href="#set_header_type" title="details" class="method-name">set_header_type</a>
299 (<span class="var-type">int</span> <span class="var-name">$type</span>)
301 <div class="method-definition">
302 <img src="../../media/images/Method.png" alt=" "/>
303 <span class="method-result">void</span>
304 <a href="#set_highlight_lines_extra_style" title="details" class="method-name">set_highlight_lines_extra_style</a>
305 (<span class="var-type">string</span> <span class="var-name">$styles</span>)
307 <div class="method-definition">
308 <img src="../../media/images/Method.png" alt=" "/>
309 <span class="method-result">void</span>
310 <a href="#set_important_styles" title="details" class="method-name">set_important_styles</a>
311 (<span class="var-type">string</span> <span class="var-name">$styles</span>)
313 <div class="method-definition">
314 <img src="../../media/images/Method.png" alt=" "/>
315 <span class="method-result">void</span>
316 <a href="#set_keyword_group_highlighting" title="details" class="method-name">set_keyword_group_highlighting</a>
317 (<span class="var-type">int</span> <span class="var-name">$key</span>, [<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
319 <div class="method-definition">
320 <img src="../../media/images/Method.png" alt=" "/>
321 <span class="method-result">void</span>
322 <a href="#set_keyword_group_style" title="details" class="method-name">set_keyword_group_style</a>
323 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
325 <div class="method-definition">
326 <img src="../../media/images/Method.png" alt=" "/>
327 <span class="method-result">void</span>
328 <a href="#set_language" title="details" class="method-name">set_language</a>
329 (<span class="var-type">string</span> <span class="var-name">$language</span>, [<span class="var-type"></span> <span class="var-name">$force_reset</span> = <span class="var-default">false</span>])
331 <div class="method-definition">
332 <img src="../../media/images/Method.png" alt=" "/>
333 <span class="method-result">void</span>
334 <a href="#set_language_path" title="details" class="method-name">set_language_path</a>
335 (<span class="var-type">string</span> <span class="var-name">$path</span>)
337 <div class="method-definition">
338 <img src="../../media/images/Method.png" alt=" "/>
339 <span class="method-result">void</span>
340 <a href="#set_line_ending" title="details" class="method-name">set_line_ending</a>
341 (<span class="var-type">string</span> <span class="var-name">$line_ending</span>)
343 <div class="method-definition">
344 <img src="../../media/images/Method.png" alt=" "/>
345 <span class="method-result">void</span>
346 <a href="#set_line_style" title="details" class="method-name">set_line_style</a>
347 (<span class="var-type">string</span> <span class="var-name">$style1</span>, [<span class="var-type">string|boolean</span> <span class="var-name">$style2</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
349 <div class="method-definition">
350 <img src="../../media/images/Method.png" alt=" "/>
351 <span class="method-result">void</span>
352 <a href="#set_link_styles" title="details" class="method-name">set_link_styles</a>
353 (<span class="var-type">int</span> <span class="var-name">$type</span>, <span class="var-type">string</span> <span class="var-name">$styles</span>)
355 <div class="method-definition">
356 <img src="../../media/images/Method.png" alt=" "/>
357 <span class="method-result">void</span>
358 <a href="#set_link_target" title="details" class="method-name">set_link_target</a>
359 (<span class="var-type">string</span> <span class="var-name">$target</span>)
361 <div class="method-definition">
362 <img src="../../media/images/Method.png" alt=" "/>
363 <span class="method-result">void</span>
364 <a href="#set_methods_highlighting" title="details" class="method-name">set_methods_highlighting</a>
365 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
367 <div class="method-definition">
368 <img src="../../media/images/Method.png" alt=" "/>
369 <span class="method-result">void</span>
370 <a href="#set_methods_style" title="details" class="method-name">set_methods_style</a>
371 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
373 <div class="method-definition">
374 <img src="../../media/images/Method.png" alt=" "/>
375 <span class="method-result">void</span>
376 <a href="#set_numbers_highlighting" title="details" class="method-name">set_numbers_highlighting</a>
377 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
379 <div class="method-definition">
380 <img src="../../media/images/Method.png" alt=" "/>
381 <span class="method-result">void</span>
382 <a href="#set_numbers_style" title="details" class="method-name">set_numbers_style</a>
383 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
385 <div class="method-definition">
386 <img src="../../media/images/Method.png" alt=" "/>
387 <span class="method-result">void</span>
388 <a href="#set_overall_class" title="details" class="method-name">set_overall_class</a>
389 (<span class="var-type">string</span> <span class="var-name">$class</span>)
391 <div class="method-definition">
392 <img src="../../media/images/Method.png" alt=" "/>
393 <span class="method-result">void</span>
394 <a href="#set_overall_id" title="details" class="method-name">set_overall_id</a>
395 (<span class="var-type">string</span> <span class="var-name">$id</span>)
397 <div class="method-definition">
398 <img src="../../media/images/Method.png" alt=" "/>
399 <span class="method-result">void</span>
400 <a href="#set_overall_style" title="details" class="method-name">set_overall_style</a>
401 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
403 <div class="method-definition">
404 <img src="../../media/images/Method.png" alt=" "/>
405 <span class="method-result">void</span>
406 <a href="#set_regexps_highlighting" title="details" class="method-name">set_regexps_highlighting</a>
407 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">boolean</span> <span class="var-name">$flag</span>)
409 <div class="method-definition">
410 <img src="../../media/images/Method.png" alt=" "/>
411 <span class="method-result">void</span>
412 <a href="#set_regexps_style" title="details" class="method-name">set_regexps_style</a>
413 (<span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">boolean</span> <span class="var-name">$style</span>, [<span class="var-type"></span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
415 <div class="method-definition">
416 <img src="../../media/images/Method.png" alt=" "/>
417 <span class="method-result">void</span>
418 <a href="#set_source" title="details" class="method-name">set_source</a>
419 (<span class="var-type">string</span> <span class="var-name">$source</span>)
421 <div class="method-definition">
422 <img src="../../media/images/Method.png" alt=" "/>
423 <span class="method-result">void</span>
424 <a href="#set_strings_highlighting" title="details" class="method-name">set_strings_highlighting</a>
425 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
427 <div class="method-definition">
428 <img src="../../media/images/Method.png" alt=" "/>
429 <span class="method-result">void</span>
430 <a href="#set_strings_style" title="details" class="method-name">set_strings_style</a>
431 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
433 <div class="method-definition">
434 <img src="../../media/images/Method.png" alt=" "/>
435 <span class="method-result">void</span>
436 <a href="#set_symbols_highlighting" title="details" class="method-name">set_symbols_highlighting</a>
437 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
439 <div class="method-definition">
440 <img src="../../media/images/Method.png" alt=" "/>
441 <span class="method-result">void</span>
442 <a href="#set_symbols_style" title="details" class="method-name">set_symbols_style</a>
443 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>], [<span class="var-type">int</span> <span class="var-name">$group</span> = <span class="var-default">0</span>])
445 <div class="method-definition">
446 <img src="../../media/images/Method.png" alt=" "/>
447 <span class="method-result">void</span>
448 <a href="#set_tab_width" title="details" class="method-name">set_tab_width</a>
449 (<span class="var-type">int</span> <span class="var-name">$width</span>)
451 <div class="method-definition">
452 <img src="../../media/images/Method.png" alt=" "/>
453 <span class="method-result">void</span>
454 <a href="#set_url_for_keyword_group" title="details" class="method-name">set_url_for_keyword_group</a>
455 (<span class="var-type">int</span> <span class="var-name">$group</span>, <span class="var-type">string</span> <span class="var-name">$url</span>)
457 <div class="method-definition">
458 <img src="../../media/images/Method.png" alt=" "/>
459 <span class="method-result">void</span>
460 <a href="#set_use_language_tab_width" title="details" class="method-name">set_use_language_tab_width</a>
461 (<span class="var-type">boolean</span> <span class="var-name">$use</span>)
463 <div class="method-definition">
464 <img src="../../media/images/Method.png" alt=" "/>
465 <span class="method-result">void</span>
466 <a href="#start_line_numbers_at" title="details" class="method-name">start_line_numbers_at</a>
467 (<span class="var-type">int</span> <span class="var-name">$number</span>)
474 <a name="sec-methods"></a>
475 <div class="info-box">
476 <div class="info-box-title">Methods</div>
477 <div class="nav-bar">
478 <a href="#sec-description">Description</a> |
479 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
482 <div class="info-box-body">
483 <A NAME='method_detail'></A>
484 <a name="methodGeSHi" id="GeSHi"><!-- --></a>
485 <div class="evenrow">
487 <div class="method-header">
488 <img src="../../media/images/Constructor.png" />
489 <span class="method-title">Constructor GeSHi</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a591">591</a></span>)
492 <!-- ========== Info from phpDoc block ========= -->
493 <p class="short-description">Creates a new GeSHi object, with source and language</p>
495 <li><span class="field">since:</span> 1.0.0</li>
498 <div class="method-signature">
499 <span class="method-result">GeSHi</span>
500 <span class="method-name">
503 ([<span class="var-type">string</span> <span class="var-name">$source</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$language</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$path</span> = <span class="var-default">''</span>])
506 <ul class="parameters">
508 <span class="var-type">string</span>
509 <span class="var-name">$source</span><span class="var-description">: The source code to highlight</span> </li>
511 <span class="var-type">string</span>
512 <span class="var-name">$language</span><span class="var-description">: The language to highlight the source with</span> </li>
514 <span class="var-type">string</span>
515 <span class="var-name">$path</span><span class="var-description">: The path to the language file directory. <strong>This
516 is deprecated!</strong> I've backported the auto path detection from the 1.1.X dev branch, so now it should be automatically set correctly. If you have renamed the language directory however, you will still need to set the path using this parameter or GeSHi->set_language_path()</span> </li>
521 <a name="methodadd_keyword" id="add_keyword"><!-- --></a>
524 <div class="method-header">
525 <img src="../../media/images/Method.png" />
526 <span class="method-title">add_keyword</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1441">1441</a></span>)
529 <!-- ========== Info from phpDoc block ========= -->
530 <p class="short-description">Adds a keyword to a keyword group for highlighting</p>
532 <li><span class="field">since:</span> 1.0.0</li>
535 <div class="method-signature">
536 <span class="method-result">void</span>
537 <span class="method-name">
540 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$word</span>)
543 <ul class="parameters">
545 <span class="var-type">int</span>
546 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to add the keyword to</span> </li>
548 <span class="var-type">string</span>
549 <span class="var-name">$word</span><span class="var-description">: The word to add to the keyword group</span> </li>
554 <a name="methodadd_keyword_group" id="add_keyword_group"><!-- --></a>
555 <div class="evenrow">
557 <div class="method-header">
558 <img src="../../media/images/Method.png" />
559 <span class="method-title">add_keyword_group</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1487">1487</a></span>)
562 <!-- ========== Info from phpDoc block ========= -->
563 <p class="short-description">Creates a new keyword group</p>
565 <li><span class="field">since:</span> 1.0.0</li>
568 <div class="method-signature">
569 <span class="method-result">void</span>
570 <span class="method-name">
573 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$styles</span>, [<span class="var-type">boolean</span> <span class="var-name">$case_sensitive</span> = <span class="var-default">true</span>], [<span class="var-type">array</span> <span class="var-name">$words</span> = <span class="var-default">array()</span>])
576 <ul class="parameters">
578 <span class="var-type">int</span>
579 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to create</span> </li>
581 <span class="var-type">string</span>
582 <span class="var-name">$styles</span><span class="var-description">: The styles for the keyword group</span> </li>
584 <span class="var-type">boolean</span>
585 <span class="var-name">$case_sensitive</span><span class="var-description">: Whether the keyword group is case sensitive ornot</span> </li>
587 <span class="var-type">array</span>
588 <span class="var-name">$words</span><span class="var-description">: The words to use for the keyword group</span> </li>
593 <a name="methoddisable_highlighting" id="disable_highlighting"><!-- --></a>
596 <div class="method-header">
597 <img src="../../media/images/Method.png" />
598 <span class="method-title">disable_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1288">1288</a></span>)
601 <!-- ========== Info from phpDoc block ========= -->
602 <p class="short-description">Disables all highlighting</p>
604 <li><span class="field">deprecated:</span> In favour of enable_highlighting</li>
605 <li><span class="field">todo:</span> Rewrite with array traversal</li>
606 <li><span class="field">since:</span> 1.0.0</li>
609 <div class="method-signature">
610 <span class="method-result">void</span>
611 <span class="method-name">
620 <a name="methodenable_classes" id="enable_classes"><!-- --></a>
621 <div class="evenrow">
623 <div class="method-header">
624 <img src="../../media/images/Method.png" />
625 <span class="method-title">enable_classes</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a805">805</a></span>)
628 <!-- ========== Info from phpDoc block ========= -->
629 <p class="short-description">Sets whether CSS classes should be used to highlight the source. Default is off, calling this method with no arguments will turn it on</p>
631 <li><span class="field">since:</span> 1.0.0</li>
634 <div class="method-signature">
635 <span class="method-result">void</span>
636 <span class="method-name">
639 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
642 <ul class="parameters">
644 <span class="var-type">boolean</span>
645 <span class="var-name">$flag</span><span class="var-description">: Whether to turn classes on or not</span> </li>
650 <a name="methodenable_highlighting" id="enable_highlighting"><!-- --></a>
653 <div class="method-header">
654 <img src="../../media/images/Method.png" />
655 <span class="method-title">enable_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1302">1302</a></span>)
658 <!-- ========== Info from phpDoc block ========= -->
659 <p class="short-description">Enables all highlighting</p>
660 <p class="description"><p>The optional flag parameter was added in version 1.0.7.21 and can be used to enable (true) or disable (false) all highlighting.</p></p>
662 <li><span class="field">todo:</span> Rewrite with array traversal</li>
663 <li><span class="field">since:</span> 1.0.0</li>
666 <div class="method-signature">
667 <span class="method-result">void</span>
668 <span class="method-name">
671 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
674 <ul class="parameters">
676 <span class="var-type">boolean</span>
677 <span class="var-name">$flag</span><span class="var-description">: A flag specifying whether to enable or disable all highlighting</span> </li>
682 <a name="methodenable_ids" id="enable_ids"><!-- --></a>
683 <div class="evenrow">
685 <div class="method-header">
686 <img src="../../media/images/Method.png" />
687 <span class="method-title">enable_ids</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1652">1652</a></span>)
690 <!-- ========== Info from phpDoc block ========= -->
691 <p class="short-description">Whether CSS IDs should be added to each line</p>
693 <li><span class="field">since:</span> 1.0.2</li>
696 <div class="method-signature">
697 <span class="method-result">void</span>
698 <span class="method-name">
701 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
704 <ul class="parameters">
706 <span class="var-type">boolean</span>
707 <span class="var-name">$flag</span><span class="var-description">: If true, IDs will be added to each line.</span> </li>
712 <a name="methodenable_important_blocks" id="enable_important_blocks"><!-- --></a>
715 <div class="method-header">
716 <img src="../../media/images/Method.png" />
717 <span class="method-title">enable_important_blocks</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1642">1642</a></span>)
720 <!-- ========== Info from phpDoc block ========= -->
721 <p class="short-description">Sets whether context-important blocks are highlighted</p>
723 <li><span class="field">deprecated:</span> </li>
724 <li><span class="field">todo:</span> REMOVE THIS SHIZ FROM GESHI!</li>
725 <li><span class="field">since:</span> 1.0.2</li>
728 <div class="method-signature">
729 <span class="method-result">void</span>
730 <span class="method-name">
731 enable_important_blocks
733 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
736 <ul class="parameters">
738 <span class="var-type">boolean</span>
739 <span class="var-name">$flag</span><span class="var-description">: Tells whether to enable or disable highlighting of important blocks</span> </li>
744 <a name="methodenable_inner_code_block" id="enable_inner_code_block"><!-- --></a>
745 <div class="evenrow">
747 <div class="method-header">
748 <img src="../../media/images/Method.png" />
749 <span class="method-title">enable_inner_code_block</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1581">1581</a></span>)
752 <!-- ========== Info from phpDoc block ========= -->
753 <p class="short-description">Sets whether to force a surrounding block around the highlighted code or not</p>
755 <li><span class="field">since:</span> 1.0.7.20</li>
758 <div class="method-signature">
759 <span class="method-result">void</span>
760 <span class="method-name">
761 enable_inner_code_block
763 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
766 <ul class="parameters">
768 <span class="var-type">boolean</span>
769 <span class="var-name">$flag</span><span class="var-description">: Tells whether to enable or disable this feature</span> </li>
774 <a name="methodenable_keyword_links" id="enable_keyword_links"><!-- --></a>
777 <div class="method-header">
778 <img src="../../media/images/Method.png" />
779 <span class="method-title">enable_keyword_links</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1756">1756</a></span>)
782 <!-- ========== Info from phpDoc block ========= -->
783 <p class="short-description">Turns linking of keywords on or off.</p>
785 <li><span class="field">since:</span> 1.0.2</li>
788 <div class="method-signature">
789 <span class="method-result">void</span>
790 <span class="method-name">
793 ([<span class="var-type">boolean</span> <span class="var-name">$enable</span> = <span class="var-default">true</span>])
796 <ul class="parameters">
798 <span class="var-type">boolean</span>
799 <span class="var-name">$enable</span><span class="var-description">: If true, links will be added to keywords</span> </li>
804 <a name="methodenable_line_numbers" id="enable_line_numbers"><!-- --></a>
805 <div class="evenrow">
807 <div class="method-header">
808 <img src="../../media/images/Method.png" />
809 <span class="method-title">enable_line_numbers</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a878">878</a></span>)
812 <!-- ========== Info from phpDoc block ========= -->
813 <p class="short-description">Sets whether line numbers should be displayed.</p>
814 <p class="description"><p>Valid values for the first parameter are:</p><p><ul><li>GESHI_NO_LINE_NUMBERS: Line numbers will not be displayed</li><li>GESHI_NORMAL_LINE_NUMBERS: Line numbers will be displayed</li><li>GESHI_FANCY_LINE_NUMBERS: Fancy line numbers will be displayed</li></ul> For fancy line numbers, the second parameter is used to signal which lines are to be fancy. For example, if the value of this parameter is 5 then every 5th line will be fancy.</p></p>
816 <li><span class="field">since:</span> 1.0.0</li>
819 <div class="method-signature">
820 <span class="method-result">void</span>
821 <span class="method-name">
824 (<span class="var-type">int</span> <span class="var-name">$flag</span>, [<span class="var-type">int</span> <span class="var-name">$nth_row</span> = <span class="var-default">5</span>])
827 <ul class="parameters">
829 <span class="var-type">int</span>
830 <span class="var-name">$flag</span><span class="var-description">: How line numbers should be displayed</span> </li>
832 <span class="var-type">int</span>
833 <span class="var-name">$nth_row</span><span class="var-description">: Defines which lines are fancy</span> </li>
838 <a name="methodenable_multiline_span" id="enable_multiline_span"><!-- --></a>
841 <div class="method-header">
842 <img src="../../media/images/Method.png" />
843 <span class="method-title">enable_multiline_span</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a896">896</a></span>)
846 <!-- ========== Info from phpDoc block ========= -->
847 <p class="short-description">Sets wether spans and other HTML markup generated by GeSHi can span over multiple lines or not. Defaults to true to reduce overhead.</p>
848 <p class="description"><p>Set it to false if you want to manipulate the output or manually display the code in an ordered list.</p></p>
850 <li><span class="field">since:</span> 1.0.7.22</li>
853 <div class="method-signature">
854 <span class="method-result">void</span>
855 <span class="method-name">
856 enable_multiline_span
858 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
861 <ul class="parameters">
863 <span class="var-type">boolean</span>
864 <span class="var-name">$flag</span><span class="var-description">: Wether multiline spans are allowed or not</span> </li>
869 <a name="methodenable_strict_mode" id="enable_strict_mode"><!-- --></a>
870 <div class="evenrow">
872 <div class="method-header">
873 <img src="../../media/images/Method.png" />
874 <span class="method-title">enable_strict_mode</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1275">1275</a></span>)
877 <!-- ========== Info from phpDoc block ========= -->
878 <p class="short-description">Enables/disables strict highlighting. Default is off, calling this method without parameters will turn it on. See documentation for more details on strict mode and where to use it.</p>
880 <li><span class="field">since:</span> 1.0.0</li>
883 <div class="method-signature">
884 <span class="method-result">void</span>
885 <span class="method-name">
888 ([<span class="var-type">boolean</span> <span class="var-name">$mode</span> = <span class="var-default">true</span>])
891 <ul class="parameters">
893 <span class="var-type">boolean</span>
894 <span class="var-name">$mode</span><span class="var-description">: Whether to enable strict mode or not</span> </li>
899 <a name="methoderror" id="error"><!-- --></a>
902 <div class="method-header">
903 <img src="../../media/images/Method.png" />
904 <span class="method-title">error</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a608">608</a></span>)
907 <!-- ========== Info from phpDoc block ========= -->
908 <p class="short-description">Returns an error message associated with the last GeSHi operation, or false if no error has occured</p>
910 <li><span class="field">return:</span> An error message if there has been an error, else false</li>
911 <li><span class="field">since:</span> 1.0.0</li>
914 <div class="method-signature">
915 <span class="method-result">string|false</span>
916 <span class="method-name">
925 <a name="methodget_language_name" id="get_language_name"><!-- --></a>
926 <div class="evenrow">
928 <div class="method-header">
929 <img src="../../media/images/Method.png" />
930 <span class="method-title">get_language_name</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a632">632</a></span>)
933 <!-- ========== Info from phpDoc block ========= -->
934 <p class="short-description">Gets a human-readable language name (thanks to Simon Patterson for the idea :))</p>
936 <li><span class="field">return:</span> The name for the current language</li>
937 <li><span class="field">since:</span> 1.0.2</li>
940 <div class="method-signature">
941 <span class="method-result">string</span>
942 <span class="method-name">
951 <a name="methodget_language_name_from_extension" id="get_language_name_from_extension"><!-- --></a>
954 <div class="method-header">
955 <img src="../../media/images/Method.png" />
956 <span class="method-title">get_language_name_from_extension</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1329">1329</a></span>)
959 <!-- ========== Info from phpDoc block ========= -->
960 <p class="short-description">Given a file extension, this method returns either a valid geshi language name, or the empty string if it couldn't be found</p>
962 <li><span class="field">todo:</span> Re-think about how this method works (maybe make it private and/or make it a extension->lang lookup?)</li>
963 <li><span class="field">todo:</span> static?</li>
964 <li><span class="field">since:</span> 1.0.5</li>
967 <div class="method-signature">
968 <span class="method-result">void</span>
969 <span class="method-name">
970 get_language_name_from_extension
972 (<span class="var-type">string</span> <span class="var-name">$extension</span>, [<span class="var-type">array</span> <span class="var-name">$lookup</span> = <span class="var-default">array()</span>])
975 <ul class="parameters">
977 <span class="var-type">string</span>
978 <span class="var-name">$extension</span><span class="var-description">: The extension to get a language name for</span> </li>
980 <span class="var-type">array</span>
981 <span class="var-name">$lookup</span><span class="var-description">: A lookup array to use instead of the default one</span> </li>
986 <a name="methodget_multiline_span" id="get_multiline_span"><!-- --></a>
987 <div class="evenrow">
989 <div class="method-header">
990 <img src="../../media/images/Method.png" />
991 <span class="method-title">get_multiline_span</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a906">906</a></span>)
994 <!-- ========== Info from phpDoc block ========= -->
995 <p class="short-description">Get current setting for multiline spans, see GeSHi->enable_multiline_span().</p>
997 <li><span class="field">see:</span> <a href="../../geshi/core/GeSHi.html#methodenable_multiline_span">GeSHi::enable_multiline_span()</a></li>
1000 <div class="method-signature">
1001 <span class="method-result">bool</span>
1002 <span class="method-name">
1011 <a name="methodget_real_tab_width" id="get_real_tab_width"><!-- --></a>
1012 <div class="oddrow">
1014 <div class="method-header">
1015 <img src="../../media/images/Method.png" />
1016 <span class="method-title">get_real_tab_width</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1258">1258</a></span>)
1019 <!-- ========== Info from phpDoc block ========= -->
1020 <p class="short-description">Returns the tab width to use, based on the current language and user preference</p>
1022 <li><span class="field">return:</span> Tab width</li>
1023 <li><span class="field">since:</span> 1.0.7.20</li>
1026 <div class="method-signature">
1027 <span class="method-result">int</span>
1028 <span class="method-name">
1037 <a name="methodget_stylesheet" id="get_stylesheet"><!-- --></a>
1038 <div class="evenrow">
1040 <div class="method-header">
1041 <img src="../../media/images/Method.png" />
1042 <span class="method-title">get_stylesheet</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a4177">4177</a></span>)
1045 <!-- ========== Info from phpDoc block ========= -->
1046 <p class="short-description">Returns a stylesheet for the highlighted code. If $economy mode is true, we only return the stylesheet declarations that matter for this code block instead of the whole thing</p>
1048 <li><span class="field">return:</span> A stylesheet built on the data for the current language</li>
1049 <li><span class="field">since:</span> 1.0.0</li>
1052 <div class="method-signature">
1053 <span class="method-result">string</span>
1054 <span class="method-name">
1057 ([<span class="var-type">boolean</span> <span class="var-name">$economy_mode</span> = <span class="var-default">true</span>])
1060 <ul class="parameters">
1062 <span class="var-type">boolean</span>
1063 <span class="var-name">$economy_mode</span><span class="var-description">: Whether to use economy mode or not</span> </li>
1068 <a name="methodget_time" id="get_time"><!-- --></a>
1069 <div class="oddrow">
1071 <div class="method-header">
1072 <img src="../../media/images/Method.png" />
1073 <span class="method-title">get_time</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a3524">3524</a></span>)
1076 <!-- ========== Info from phpDoc block ========= -->
1077 <p class="short-description">Gets the time taken to parse the code</p>
1079 <li><span class="field">return:</span> The time taken to parse the code</li>
1080 <li><span class="field">since:</span> 1.0.2</li>
1083 <div class="method-signature">
1084 <span class="method-result">double</span>
1085 <span class="method-name">
1094 <a name="methodhighlight_lines_extra" id="highlight_lines_extra"><!-- --></a>
1095 <div class="evenrow">
1097 <div class="method-header">
1098 <img src="../../media/images/Method.png" />
1099 <span class="method-title">highlight_lines_extra</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1670">1670</a></span>)
1102 <!-- ========== Info from phpDoc block ========= -->
1103 <p class="short-description">Specifies which lines to highlight extra</p>
1104 <p class="description"><p>The extra style parameter was added in 1.0.7.21.</p></p>
1106 <li><span class="field">todo:</span> Some data replication here that could be cut down on</li>
1107 <li><span class="field">since:</span> 1.0.2</li>
1110 <div class="method-signature">
1111 <span class="method-result">void</span>
1112 <span class="method-name">
1113 highlight_lines_extra
1115 (<span class="var-type">mixed</span> <span class="var-name">$lines</span>, [<span class="var-type">string</span> <span class="var-name">$style</span> = <span class="var-default">null</span>])
1118 <ul class="parameters">
1120 <span class="var-type">mixed</span>
1121 <span class="var-name">$lines</span><span class="var-description">: An array of line numbers to highlight, or just a line number on its own.</span> </li>
1123 <span class="var-type">string</span>
1124 <span class="var-name">$style</span><span class="var-description">: A string specifying the style to use for this line. If null is specified, the default style is used. If false is specified, the line will be removed from special highlighting</span> </li>
1129 <a name="methodload_from_file" id="load_from_file"><!-- --></a>
1130 <div class="oddrow">
1132 <div class="method-header">
1133 <img src="../../media/images/Method.png" />
1134 <span class="method-title">load_from_file</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1425">1425</a></span>)
1137 <!-- ========== Info from phpDoc block ========= -->
1138 <p class="short-description">Given a file name, this method loads its contents in, and attempts</p>
1139 <p class="description"><p>to set the language automatically. An optional lookup table can be passed for looking up the language name. If not specified a default table is used</p><p>The language table is in the form <pre>array(
1140 'lang_name' => array('extension', 'extension', ...),
1144 <li><span class="field">todo:</span> Complete rethink of this and above method</li>
1145 <li><span class="field">since:</span> 1.0.5</li>
1148 <div class="method-signature">
1149 <span class="method-result">void</span>
1150 <span class="method-name">
1153 (<span class="var-type">string</span> <span class="var-name">$file_name</span>, [<span class="var-type">array</span> <span class="var-name">$lookup</span> = <span class="var-default">array()</span>])
1156 <ul class="parameters">
1158 <span class="var-type">string</span>
1159 <span class="var-name">$file_name</span><span class="var-description">: The filename to load the source from</span> </li>
1161 <span class="var-type">array</span>
1162 <span class="var-name">$lookup</span><span class="var-description">: A lookup array to use instead of the default one</span> </li>
1167 <a name="methodoptimize_keyword_group" id="optimize_keyword_group"><!-- --></a>
1168 <div class="evenrow">
1170 <div class="method-header">
1171 <img src="../../media/images/Method.png" />
1172 <span class="method-title">optimize_keyword_group</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1529">1529</a></span>)
1175 <!-- ========== Info from phpDoc block ========= -->
1176 <p class="short-description">compile optimized regexp list for keyword group</p>
1178 <li><span class="field">since:</span> 1.0.8</li>
1181 <div class="method-signature">
1182 <span class="method-result">void</span>
1183 <span class="method-name">
1184 optimize_keyword_group
1186 (<span class="var-type">int</span> <span class="var-name">$key</span>)
1189 <ul class="parameters">
1191 <span class="var-type">int</span>
1192 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to compile & optimize</span> </li>
1197 <a name="methodparse_code" id="parse_code"><!-- --></a>
1198 <div class="oddrow">
1200 <div class="method-header">
1201 <img src="../../media/images/Method.png" />
1202 <span class="method-title">parse_code</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1992">1992</a></span>)
1205 <!-- ========== Info from phpDoc block ========= -->
1206 <p class="short-description">Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.</p>
1207 <p class="description"><p>This should only be called ONCE, cos it's SLOW! If you want to highlight the same source multiple times, you're better off doing a whole lot of str_replaces to replace the &lt;span&gt;s</p></p>
1209 <li><span class="field">since:</span> 1.0.0</li>
1212 <div class="method-signature">
1213 <span class="method-result">void</span>
1214 <span class="method-name">
1223 <a name="methodremove_keyword" id="remove_keyword"><!-- --></a>
1224 <div class="evenrow">
1226 <div class="method-header">
1227 <img src="../../media/images/Method.png" />
1228 <span class="method-title">remove_keyword</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1466">1466</a></span>)
1231 <!-- ========== Info from phpDoc block ========= -->
1232 <p class="short-description">Removes a keyword from a keyword group</p>
1234 <li><span class="field">since:</span> 1.0.0</li>
1237 <div class="method-signature">
1238 <span class="method-result">void</span>
1239 <span class="method-name">
1242 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$word</span>, [<span class="var-type">bool</span> <span class="var-name">$recompile</span> = <span class="var-default">true</span>])
1245 <ul class="parameters">
1247 <span class="var-type">int</span>
1248 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to remove the keyword from</span> </li>
1250 <span class="var-type">string</span>
1251 <span class="var-name">$word</span><span class="var-description">: The word to remove from the keyword group</span> </li>
1253 <span class="var-type">bool</span>
1254 <span class="var-name">$recompile</span><span class="var-description">: Wether to automatically recompile the optimized regexp list or not. Note: if you set this to false and @see GeSHi->parse_code() was already called once, for the current language, you have to manually call @see GeSHi->optimize_keyword_group() or the removed keyword will stay in cache and still be highlighted! On the other hand it might be too expensive to recompile the regexp list for every removal if you want to remove a lot of keywords.</span> </li>
1259 <a name="methodremove_keyword_group" id="remove_keyword_group"><!-- --></a>
1260 <div class="oddrow">
1262 <div class="method-header">
1263 <img src="../../media/images/Method.png" />
1264 <span class="method-title">remove_keyword_group</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1512">1512</a></span>)
1267 <!-- ========== Info from phpDoc block ========= -->
1268 <p class="short-description">Removes a keyword group</p>
1270 <li><span class="field">since:</span> 1.0.0</li>
1273 <div class="method-signature">
1274 <span class="method-result">void</span>
1275 <span class="method-name">
1276 remove_keyword_group
1278 (<span class="var-type">int</span> <span class="var-name">$key</span>)
1281 <ul class="parameters">
1283 <span class="var-type">int</span>
1284 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to remove</span> </li>
1289 <a name="methodset_brackets_highlighting" id="set_brackets_highlighting"><!-- --></a>
1290 <div class="evenrow">
1292 <div class="method-header">
1293 <img src="../../media/images/Method.png" />
1294 <span class="method-title">set_brackets_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1036">1036</a></span>)
1297 <!-- ========== Info from phpDoc block ========= -->
1298 <p class="short-description">Turns highlighting on/off for brackets</p>
1299 <p class="description"><p>This method is DEPRECATED: use set_symbols_highlighting instead. This method will be remove in 1.2.X</p></p>
1301 <li><span class="field">deprecated:</span> In favour of set_symbols_highlighting</li>
1302 <li><span class="field">since:</span> 1.0.0</li>
1305 <div class="method-signature">
1306 <span class="method-result">void</span>
1307 <span class="method-name">
1308 set_brackets_highlighting
1310 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
1313 <ul class="parameters">
1315 <span class="var-type">boolean</span>
1316 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for brackets on or off</span> </li>
1321 <a name="methodset_brackets_style" id="set_brackets_style"><!-- --></a>
1322 <div class="oddrow">
1324 <div class="method-header">
1325 <img src="../../media/images/Method.png" />
1326 <span class="method-title">set_brackets_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1018">1018</a></span>)
1329 <!-- ========== Info from phpDoc block ========= -->
1330 <p class="short-description">Sets the styles for brackets. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
1331 <p class="description"><p>This method is DEPRECATED: use set_symbols_style instead. This method will be removed in 1.2.X</p></p>
1333 <li><span class="field">deprecated:</span> In favour of set_symbols_style</li>
1334 <li><span class="field">since:</span> 1.0.0</li>
1337 <div class="method-signature">
1338 <span class="method-result">void</span>
1339 <span class="method-name">
1342 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
1345 <ul class="parameters">
1347 <span class="var-type">string</span>
1348 <span class="var-name">$style</span><span class="var-description">: The style to make the brackets</span> </li>
1350 <span class="var-type">boolean</span>
1351 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
1356 <a name="methodset_case_keywords" id="set_case_keywords"><!-- --></a>
1357 <div class="evenrow">
1359 <div class="method-header">
1360 <img src="../../media/images/Method.png" />
1361 <span class="method-title">set_case_keywords</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1216">1216</a></span>)
1364 <!-- ========== Info from phpDoc block ========= -->
1365 <p class="short-description">Sets the case that keywords should use when found. Use the constants:</p>
1366 <p class="description"><p><ul><li>GESHI_CAPS_NO_CHANGE: leave keywords as-is</li><li>GESHI_CAPS_UPPER: convert all keywords to uppercase where found</li><li>GESHI_CAPS_LOWER: convert all keywords to lowercase where found</li></ul></p></p>
1368 <li><span class="field">since:</span> 1.0.1</li>
1371 <div class="method-signature">
1372 <span class="method-result">void</span>
1373 <span class="method-name">
1376 (<span class="var-type">int</span> <span class="var-name">$case</span>)
1379 <ul class="parameters">
1381 <span class="var-type">int</span>
1382 <span class="var-name">$case</span><span class="var-description">: A constant specifying what to do with matched keywords</span> </li>
1387 <a name="methodset_case_sensitivity" id="set_case_sensitivity"><!-- --></a>
1388 <div class="oddrow">
1390 <div class="method-header">
1391 <img src="../../media/images/Method.png" />
1392 <span class="method-title">set_case_sensitivity</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1202">1202</a></span>)
1395 <!-- ========== Info from phpDoc block ========= -->
1396 <p class="short-description">Sets whether a set of keywords are checked for in a case sensitive manner</p>
1398 <li><span class="field">since:</span> 1.0.0</li>
1401 <div class="method-signature">
1402 <span class="method-result">void</span>
1403 <span class="method-name">
1404 set_case_sensitivity
1406 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">boolean</span> <span class="var-name">$case</span>)
1409 <ul class="parameters">
1411 <span class="var-type">int</span>
1412 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to change the case sensitivity of</span> </li>
1414 <span class="var-type">boolean</span>
1415 <span class="var-name">$case</span><span class="var-description">: Whether to check in a case sensitive manner or not</span> </li>
1420 <a name="methodset_code_style" id="set_code_style"><!-- --></a>
1421 <div class="evenrow">
1423 <div class="method-header">
1424 <img src="../../media/images/Method.png" />
1425 <span class="method-title">set_code_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a824">824</a></span>)
1428 <!-- ========== Info from phpDoc block ========= -->
1429 <p class="short-description">Sets the style for the actual code. This should be a string</p>
1430 <p class="description"><p>containing valid stylesheet declarations. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p><p>Note: Use this method to override any style changes you made to the line numbers if you are using line numbers, else the line of code will have the same style as the line number! Consult the GeSHi documentation for more information about this.</p></p>
1432 <li><span class="field">since:</span> 1.0.2</li>
1435 <div class="method-signature">
1436 <span class="method-result">void</span>
1437 <span class="method-name">
1440 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
1443 <ul class="parameters">
1445 <span class="var-type">string</span>
1446 <span class="var-name">$style</span><span class="var-description">: The style to use for actual code</span> </li>
1448 <span class="var-type">boolean</span>
1449 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the current styles with the new styles</span> </li>
1454 <a name="methodset_comments_highlighting" id="set_comments_highlighting"><!-- --></a>
1455 <div class="oddrow">
1457 <div class="method-header">
1458 <img src="../../media/images/Method.png" />
1459 <span class="method-title">set_comments_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a972">972</a></span>)
1462 <!-- ========== Info from phpDoc block ========= -->
1463 <p class="short-description">Turns highlighting on/off for comment groups</p>
1465 <li><span class="field">since:</span> 1.0.0</li>
1468 <div class="method-signature">
1469 <span class="method-result">void</span>
1470 <span class="method-name">
1471 set_comments_highlighting
1473 (<span class="var-type">int</span> <span class="var-name">$key</span>, [<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
1476 <ul class="parameters">
1478 <span class="var-type">int</span>
1479 <span class="var-name">$key</span><span class="var-description">: The key of the comment group to turn on or off</span> </li>
1481 <span class="var-type">boolean</span>
1482 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for that group on or off</span> </li>
1487 <a name="methodset_comments_style" id="set_comments_style"><!-- --></a>
1488 <div class="evenrow">
1490 <div class="method-header">
1491 <img src="../../media/images/Method.png" />
1492 <span class="method-title">set_comments_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a957">957</a></span>)
1495 <!-- ========== Info from phpDoc block ========= -->
1496 <p class="short-description">Sets the styles for comment groups. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
1498 <li><span class="field">since:</span> 1.0.0</li>
1501 <div class="method-signature">
1502 <span class="method-result">void</span>
1503 <span class="method-name">
1506 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
1509 <ul class="parameters">
1511 <span class="var-type">int</span>
1512 <span class="var-name">$key</span><span class="var-description">: The key of the comment group to change the styles of</span> </li>
1514 <span class="var-type">string</span>
1515 <span class="var-name">$style</span><span class="var-description">: The style to make the comments</span> </li>
1517 <span class="var-type">boolean</span>
1518 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
1523 <a name="methodset_encoding" id="set_encoding"><!-- --></a>
1524 <div class="oddrow">
1526 <div class="method-header">
1527 <img src="../../media/images/Method.png" />
1528 <span class="method-title">set_encoding</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1744">1744</a></span>)
1531 <!-- ========== Info from phpDoc block ========= -->
1532 <p class="short-description">Sets the encoding used for htmlspecialchars(), for international support.</p>
1533 <p class="description"><p>NOTE: This is not needed for now because htmlspecialchars() is not being used (it has a security hole in PHP4 that has not been patched). Maybe in a future version it may make a return for speed reasons, but I doubt it.</p></p>
1535 <li><span class="field">since:</span> 1.0.3</li>
1538 <div class="method-signature">
1539 <span class="method-result">void</span>
1540 <span class="method-name">
1543 (<span class="var-type">string</span> <span class="var-name">$encoding</span>)
1546 <ul class="parameters">
1548 <span class="var-type">string</span>
1549 <span class="var-name">$encoding</span><span class="var-description">: The encoding to use for the source</span> </li>
1554 <a name="methodset_escape_characters_highlighting" id="set_escape_characters_highlighting"><!-- --></a>
1555 <div class="evenrow">
1557 <div class="method-header">
1558 <img src="../../media/images/Method.png" />
1559 <span class="method-title">set_escape_characters_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1000">1000</a></span>)
1562 <!-- ========== Info from phpDoc block ========= -->
1563 <p class="short-description">Turns highlighting on/off for escaped characters</p>
1565 <li><span class="field">since:</span> 1.0.0</li>
1568 <div class="method-signature">
1569 <span class="method-result">void</span>
1570 <span class="method-name">
1571 set_escape_characters_highlighting
1573 ([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
1576 <ul class="parameters">
1578 <span class="var-type">boolean</span>
1579 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for escape characters on or off</span> </li>
1584 <a name="methodset_escape_characters_style" id="set_escape_characters_style"><!-- --></a>
1585 <div class="oddrow">
1587 <div class="method-header">
1588 <img src="../../media/images/Method.png" />
1589 <span class="method-title">set_escape_characters_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a986">986</a></span>)
1592 <!-- ========== Info from phpDoc block ========= -->
1593 <p class="short-description">Sets the styles for escaped characters. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
1595 <li><span class="field">since:</span> 1.0.0</li>
1598 <div class="method-signature">
1599 <span class="method-result">void</span>
1600 <span class="method-name">
1601 set_escape_characters_style
1603 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
1606 <ul class="parameters">
1608 <span class="var-type">string</span>
1609 <span class="var-name">$style</span><span class="var-description">: The style to make the escape characters</span> </li>
1611 <span class="var-type">boolean</span>
1612 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
1617 <a name="methodset_footer_content" id="set_footer_content"><!-- --></a>
1618 <div class="evenrow">
1620 <div class="method-header">
1621 <img src="../../media/images/Method.png" />
1622 <span class="method-title">set_footer_content</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1550">1550</a></span>)
1625 <!-- ========== Info from phpDoc block ========= -->
1626 <p class="short-description">Sets the content of the footer block</p>
1628 <li><span class="field">since:</span> 1.0.2</li>
1631 <div class="method-signature">
1632 <span class="method-result">void</span>
1633 <span class="method-name">
1636 (<span class="var-type">string</span> <span class="var-name">$content</span>)
1639 <ul class="parameters">
1641 <span class="var-type">string</span>
1642 <span class="var-name">$content</span><span class="var-description">: The content of the footer block</span> </li>
1647 <a name="methodset_footer_content_style" id="set_footer_content_style"><!-- --></a>
1648 <div class="oddrow">
1650 <div class="method-header">
1651 <img src="../../media/images/Method.png" />
1652 <span class="method-title">set_footer_content_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1570">1570</a></span>)
1655 <!-- ========== Info from phpDoc block ========= -->
1656 <p class="short-description">Sets the style for the footer content</p>
1658 <li><span class="field">since:</span> 1.0.2</li>
1661 <div class="method-signature">
1662 <span class="method-result">void</span>
1663 <span class="method-name">
1664 set_footer_content_style
1666 (<span class="var-type">string</span> <span class="var-name">$style</span>)
1669 <ul class="parameters">
1671 <span class="var-type">string</span>
1672 <span class="var-name">$style</span><span class="var-description">: The style for the footer content</span> </li>
1677 <a name="methodset_header_content" id="set_header_content"><!-- --></a>
1678 <div class="evenrow">
1680 <div class="method-header">
1681 <img src="../../media/images/Method.png" />
1682 <span class="method-title">set_header_content</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1540">1540</a></span>)
1685 <!-- ========== Info from phpDoc block ========= -->
1686 <p class="short-description">Sets the content of the header block</p>
1688 <li><span class="field">since:</span> 1.0.2</li>
1691 <div class="method-signature">
1692 <span class="method-result">void</span>
1693 <span class="method-name">
1696 (<span class="var-type">string</span> <span class="var-name">$content</span>)
1699 <ul class="parameters">
1701 <span class="var-type">string</span>
1702 <span class="var-name">$content</span><span class="var-description">: The content of the header block</span> </li>
1707 <a name="methodset_header_content_style" id="set_header_content_style"><!-- --></a>
1708 <div class="oddrow">
1710 <div class="method-header">
1711 <img src="../../media/images/Method.png" />
1712 <span class="method-title">set_header_content_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1560">1560</a></span>)
1715 <!-- ========== Info from phpDoc block ========= -->
1716 <p class="short-description">Sets the style for the header content</p>
1718 <li><span class="field">since:</span> 1.0.2</li>
1721 <div class="method-signature">
1722 <span class="method-result">void</span>
1723 <span class="method-name">
1724 set_header_content_style
1726 (<span class="var-type">string</span> <span class="var-name">$style</span>)
1729 <ul class="parameters">
1731 <span class="var-type">string</span>
1732 <span class="var-name">$style</span><span class="var-description">: The style for the header content</span> </li>
1737 <a name="methodset_header_type" id="set_header_type"><!-- --></a>
1738 <div class="evenrow">
1740 <div class="method-header">
1741 <img src="../../media/images/Method.png" />
1742 <span class="method-title">set_header_type</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a746">746</a></span>)
1745 <!-- ========== Info from phpDoc block ========= -->
1746 <p class="short-description">Sets the type of header to be used.</p>
1747 <p class="description"><p>If GESHI_HEADER_DIV is used, the code is surrounded in a "div".This means more source code but more control over tab width and line-wrapping. GESHI_HEADER_PRE means that a "pre" is used - less source, but less control. Default is GESHI_HEADER_PRE.</p><p>From 1.0.7.2, you can use GESHI_HEADER_NONE to specify that no header code should be outputted.</p></p>
1749 <li><span class="field">since:</span> 1.0.0</li>
1752 <div class="method-signature">
1753 <span class="method-result">void</span>
1754 <span class="method-name">
1757 (<span class="var-type">int</span> <span class="var-name">$type</span>)
1760 <ul class="parameters">
1762 <span class="var-type">int</span>
1763 <span class="var-name">$type</span><span class="var-description">: The type of header to be used</span> </li>
1768 <a name="methodset_highlight_lines_extra_style" id="set_highlight_lines_extra_style"><!-- --></a>
1769 <div class="oddrow">
1771 <div class="method-header">
1772 <img src="../../media/images/Method.png" />
1773 <span class="method-title">set_highlight_lines_extra_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1699">1699</a></span>)
1776 <!-- ========== Info from phpDoc block ========= -->
1777 <p class="short-description">Sets the style for extra-highlighted lines</p>
1779 <li><span class="field">since:</span> 1.0.2</li>
1782 <div class="method-signature">
1783 <span class="method-result">void</span>
1784 <span class="method-name">
1785 set_highlight_lines_extra_style
1787 (<span class="var-type">string</span> <span class="var-name">$styles</span>)
1790 <ul class="parameters">
1792 <span class="var-type">string</span>
1793 <span class="var-name">$styles</span><span class="var-description">: The style for extra-highlighted lines</span> </li>
1798 <a name="methodset_important_styles" id="set_important_styles"><!-- --></a>
1799 <div class="evenrow">
1801 <div class="method-header">
1802 <img src="../../media/images/Method.png" />
1803 <span class="method-title">set_important_styles</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1630">1630</a></span>)
1806 <!-- ========== Info from phpDoc block ========= -->
1807 <p class="short-description">Sets styles for important parts of the code</p>
1809 <li><span class="field">since:</span> 1.0.2</li>
1812 <div class="method-signature">
1813 <span class="method-result">void</span>
1814 <span class="method-name">
1815 set_important_styles
1817 (<span class="var-type">string</span> <span class="var-name">$styles</span>)
1820 <ul class="parameters">
1822 <span class="var-type">string</span>
1823 <span class="var-name">$styles</span><span class="var-description">: The styles to use on important parts of the code</span> </li>
1828 <a name="methodset_keyword_group_highlighting" id="set_keyword_group_highlighting"><!-- --></a>
1829 <div class="oddrow">
1831 <div class="method-header">
1832 <img src="../../media/images/Method.png" />
1833 <span class="method-title">set_keyword_group_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a942">942</a></span>)
1836 <!-- ========== Info from phpDoc block ========= -->
1837 <p class="short-description">Turns highlighting on/off for a keyword group</p>
1839 <li><span class="field">since:</span> 1.0.0</li>
1842 <div class="method-signature">
1843 <span class="method-result">void</span>
1844 <span class="method-name">
1845 set_keyword_group_highlighting
1847 (<span class="var-type">int</span> <span class="var-name">$key</span>, [<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>])
1850 <ul class="parameters">
1852 <span class="var-type">int</span>
1853 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to turn on or off</span> </li>
1855 <span class="var-type">boolean</span>
1856 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for that group on or off</span> </li>
1861 <a name="methodset_keyword_group_style" id="set_keyword_group_style"><!-- --></a>
1862 <div class="evenrow">
1864 <div class="method-header">
1865 <img src="../../media/images/Method.png" />
1866 <span class="method-title">set_keyword_group_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a921">921</a></span>)
1869 <!-- ========== Info from phpDoc block ========= -->
1870 <p class="short-description">Sets the style for a keyword group. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
1872 <li><span class="field">since:</span> 1.0.0</li>
1875 <div class="method-signature">
1876 <span class="method-result">void</span>
1877 <span class="method-name">
1878 set_keyword_group_style
1880 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
1883 <ul class="parameters">
1885 <span class="var-type">int</span>
1886 <span class="var-name">$key</span><span class="var-description">: The key of the keyword group to change the styles of</span> </li>
1888 <span class="var-type">string</span>
1889 <span class="var-name">$style</span><span class="var-description">: The style to make the keywords</span> </li>
1891 <span class="var-type">boolean</span>
1892 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
1897 <a name="methodset_language" id="set_language"><!-- --></a>
1898 <div class="oddrow">
1900 <div class="method-header">
1901 <img src="../../media/images/Method.png" />
1902 <span class="method-title">set_language</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a659">659</a></span>)
1905 <!-- ========== Info from phpDoc block ========= -->
1906 <p class="short-description">Sets the language for this object</p>
1908 <li><span class="field">since:</span> 1.0.0</li>
1909 <li><span class="field">note:</span> since 1.0.8 this function won't reset language-settings by default anymore! if you need this set $force_reset = true</li>
1912 <div class="method-signature">
1913 <span class="method-result">void</span>
1914 <span class="method-name">
1917 (<span class="var-type">string</span> <span class="var-name">$language</span>, [<span class="var-type"></span> <span class="var-name">$force_reset</span> = <span class="var-default">false</span>])
1920 <ul class="parameters">
1922 <span class="var-type">string</span>
1923 <span class="var-name">$language</span><span class="var-description">: The name of the language to use</span> </li>
1925 <span class="var-type"></span>
1926 <span class="var-name">$force_reset</span> </li>
1931 <a name="methodset_language_path" id="set_language_path"><!-- --></a>
1932 <div class="evenrow">
1934 <div class="method-header">
1935 <img src="../../media/images/Method.png" />
1936 <span class="method-title">set_language_path</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a703">703</a></span>)
1939 <!-- ========== Info from phpDoc block ========= -->
1940 <p class="short-description">Sets the path to the directory containing the language files. Note that this path is relative to the directory of the script that included geshi.php, NOT geshi.php itself.</p>
1942 <li><span class="field">deprecated:</span> The path to the language files should now be automatically detected, so this method should no longer be needed. The 1.1.X branch handles manual setting of the path differently so this method will disappear in 1.2.0.</li>
1943 <li><span class="field">since:</span> 1.0.0</li>
1946 <div class="method-signature">
1947 <span class="method-result">void</span>
1948 <span class="method-name">
1951 (<span class="var-type">string</span> <span class="var-name">$path</span>)
1954 <ul class="parameters">
1956 <span class="var-type">string</span>
1957 <span class="var-name">$path</span><span class="var-description">: The path to the language directory</span> </li>
1962 <a name="methodset_line_ending" id="set_line_ending"><!-- --></a>
1963 <div class="oddrow">
1965 <div class="method-header">
1966 <img src="../../media/images/Method.png" />
1967 <span class="method-title">set_line_ending</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1709">1709</a></span>)
1970 <!-- ========== Info from phpDoc block ========= -->
1971 <p class="short-description">Sets the line-ending</p>
1973 <li><span class="field">since:</span> 1.0.2</li>
1976 <div class="method-signature">
1977 <span class="method-result">void</span>
1978 <span class="method-name">
1981 (<span class="var-type">string</span> <span class="var-name">$line_ending</span>)
1984 <ul class="parameters">
1986 <span class="var-type">string</span>
1987 <span class="var-name">$line_ending</span><span class="var-description">: The new line-ending</span> </li>
1992 <a name="methodset_line_style" id="set_line_style"><!-- --></a>
1993 <div class="evenrow">
1995 <div class="method-header">
1996 <img src="../../media/images/Method.png" />
1997 <span class="method-title">set_line_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a844">844</a></span>)
2000 <!-- ========== Info from phpDoc block ========= -->
2001 <p class="short-description">Sets the styles for the line numbers.</p>
2003 <li><span class="field">since:</span> 1.0.2</li>
2006 <div class="method-signature">
2007 <span class="method-result">void</span>
2008 <span class="method-name">
2011 (<span class="var-type">string</span> <span class="var-name">$style1</span>, [<span class="var-type">string|boolean</span> <span class="var-name">$style2</span> = <span class="var-default">''</span>], [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
2014 <ul class="parameters">
2016 <span class="var-type">string</span>
2017 <span class="var-name">$style1</span><span class="var-description">: The style for the line numbers that are "normal"</span> </li>
2019 <span class="var-type">string|boolean</span>
2020 <span class="var-name">$style2</span><span class="var-description">: If a string, this is the style of the line numbers that are "fancy", otherwise if boolean then this defines whether the normal styles should be merged with the new normal styles or not</span> </li>
2022 <span class="var-type">boolean</span>
2023 <span class="var-name">$preserve_defaults</span><span class="var-description">: If set, is the flag for whether to merge the "fancy" styles with the current styles or not</span> </li>
2028 <a name="methodset_link_styles" id="set_link_styles"><!-- --></a>
2029 <div class="oddrow">
2031 <div class="method-header">
2032 <img src="../../media/images/Method.png" />
2033 <span class="method-title">set_link_styles</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1606">1606</a></span>)
2036 <!-- ========== Info from phpDoc block ========= -->
2037 <p class="short-description">Sets styles for links in code</p>
2039 <li><span class="field">since:</span> 1.0.2</li>
2042 <div class="method-signature">
2043 <span class="method-result">void</span>
2044 <span class="method-name">
2047 (<span class="var-type">int</span> <span class="var-name">$type</span>, <span class="var-type">string</span> <span class="var-name">$styles</span>)
2050 <ul class="parameters">
2052 <span class="var-type">int</span>
2053 <span class="var-name">$type</span><span class="var-description">: A constant that specifies what state the style is being set for - e.g. :hover or :visited</span> </li>
2055 <span class="var-type">string</span>
2056 <span class="var-name">$styles</span><span class="var-description">: The styles to use for that state</span> </li>
2061 <a name="methodset_link_target" id="set_link_target"><!-- --></a>
2062 <div class="evenrow">
2064 <div class="method-header">
2065 <img src="../../media/images/Method.png" />
2066 <span class="method-title">set_link_target</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1616">1616</a></span>)
2069 <!-- ========== Info from phpDoc block ========= -->
2070 <p class="short-description">Sets the target for links in code</p>
2072 <li><span class="field">since:</span> 1.0.3</li>
2075 <div class="method-signature">
2076 <span class="method-result">void</span>
2077 <span class="method-name">
2080 (<span class="var-type">string</span> <span class="var-name">$target</span>)
2083 <ul class="parameters">
2085 <span class="var-type">string</span>
2086 <span class="var-name">$target</span><span class="var-description">: The target for links in the code, e.g. _blank</span> </li>
2091 <a name="methodset_methods_highlighting" id="set_methods_highlighting"><!-- --></a>
2092 <div class="oddrow">
2094 <div class="method-header">
2095 <img src="../../media/images/Method.png" />
2096 <span class="method-title">set_methods_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1162">1162</a></span>)
2099 <!-- ========== Info from phpDoc block ========= -->
2100 <p class="short-description">Turns highlighting on/off for methods</p>
2102 <li><span class="field">since:</span> 1.0.0</li>
2105 <div class="method-signature">
2106 <span class="method-result">void</span>
2107 <span class="method-name">
2108 set_methods_highlighting
2110 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
2113 <ul class="parameters">
2115 <span class="var-type">boolean</span>
2116 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for methods on or off</span> </li>
2121 <a name="methodset_methods_style" id="set_methods_style"><!-- --></a>
2122 <div class="evenrow">
2124 <div class="method-header">
2125 <img src="../../media/images/Method.png" />
2126 <span class="method-title">set_methods_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1148">1148</a></span>)
2129 <!-- ========== Info from phpDoc block ========= -->
2130 <p class="short-description">Sets the styles for methods. $key is a number that references the</p>
2131 <p class="description"><p>appropriate "object splitter" - see the language file for the language you are highlighting to get this number. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p></p>
2133 <li><span class="field">since:</span> 1.0.0</li>
2136 <div class="method-signature">
2137 <span class="method-result">void</span>
2138 <span class="method-name">
2141 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
2144 <ul class="parameters">
2146 <span class="var-type">int</span>
2147 <span class="var-name">$key</span><span class="var-description">: The key of the object splitter to change the styles of</span> </li>
2149 <span class="var-type">string</span>
2150 <span class="var-name">$style</span><span class="var-description">: The style to make the methods</span> </li>
2152 <span class="var-type">boolean</span>
2153 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
2158 <a name="methodset_numbers_highlighting" id="set_numbers_highlighting"><!-- --></a>
2159 <div class="oddrow">
2161 <div class="method-header">
2162 <img src="../../media/images/Method.png" />
2163 <span class="method-title">set_numbers_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1131">1131</a></span>)
2166 <!-- ========== Info from phpDoc block ========= -->
2167 <p class="short-description">Turns highlighting on/off for numbers</p>
2169 <li><span class="field">since:</span> 1.0.0</li>
2172 <div class="method-signature">
2173 <span class="method-result">void</span>
2174 <span class="method-name">
2175 set_numbers_highlighting
2177 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
2180 <ul class="parameters">
2182 <span class="var-type">boolean</span>
2183 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for numbers on or off</span> </li>
2188 <a name="methodset_numbers_style" id="set_numbers_style"><!-- --></a>
2189 <div class="evenrow">
2191 <div class="method-header">
2192 <img src="../../media/images/Method.png" />
2193 <span class="method-title">set_numbers_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1117">1117</a></span>)
2196 <!-- ========== Info from phpDoc block ========= -->
2197 <p class="short-description">Sets the styles for numbers. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
2199 <li><span class="field">since:</span> 1.0.0</li>
2202 <div class="method-signature">
2203 <span class="method-result">void</span>
2204 <span class="method-name">
2207 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
2210 <ul class="parameters">
2212 <span class="var-type">string</span>
2213 <span class="var-name">$style</span><span class="var-description">: The style to make the numbers</span> </li>
2215 <span class="var-type">boolean</span>
2216 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
2221 <a name="methodset_overall_class" id="set_overall_class"><!-- --></a>
2222 <div class="oddrow">
2224 <div class="method-header">
2225 <img src="../../media/images/Method.png" />
2226 <span class="method-title">set_overall_class</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a783">783</a></span>)
2229 <!-- ========== Info from phpDoc block ========= -->
2230 <p class="short-description">Sets the overall classname for this block of code. This class can then be used in a stylesheet to style this object's output</p>
2232 <li><span class="field">since:</span> 1.0.0</li>
2235 <div class="method-signature">
2236 <span class="method-result">void</span>
2237 <span class="method-name">
2240 (<span class="var-type">string</span> <span class="var-name">$class</span>)
2243 <ul class="parameters">
2245 <span class="var-type">string</span>
2246 <span class="var-name">$class</span><span class="var-description">: The class name to use for this block of code</span> </li>
2251 <a name="methodset_overall_id" id="set_overall_id"><!-- --></a>
2252 <div class="evenrow">
2254 <div class="method-header">
2255 <img src="../../media/images/Method.png" />
2256 <span class="method-title">set_overall_id</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a794">794</a></span>)
2259 <!-- ========== Info from phpDoc block ========= -->
2260 <p class="short-description">Sets the overall id for this block of code. This id can then be used in a stylesheet to style this object's output</p>
2262 <li><span class="field">since:</span> 1.0.0</li>
2265 <div class="method-signature">
2266 <span class="method-result">void</span>
2267 <span class="method-name">
2270 (<span class="var-type">string</span> <span class="var-name">$id</span>)
2273 <ul class="parameters">
2275 <span class="var-type">string</span>
2276 <span class="var-name">$id</span><span class="var-description">: The ID to use for this block of code</span> </li>
2281 <a name="methodset_overall_style" id="set_overall_style"><!-- --></a>
2282 <div class="oddrow">
2284 <div class="method-header">
2285 <img src="../../media/images/Method.png" />
2286 <span class="method-title">set_overall_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a767">767</a></span>)
2289 <!-- ========== Info from phpDoc block ========= -->
2290 <p class="short-description">Sets the styles for the code that will be outputted when this object is parsed. The style should be a string of valid stylesheet declarations</p>
2292 <li><span class="field">since:</span> 1.0.0</li>
2295 <div class="method-signature">
2296 <span class="method-result">void</span>
2297 <span class="method-name">
2300 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
2303 <ul class="parameters">
2305 <span class="var-type">string</span>
2306 <span class="var-name">$style</span><span class="var-description">: The overall style for the outputted code block</span> </li>
2308 <span class="var-type">boolean</span>
2309 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the styles with the current styles or not</span> </li>
2314 <a name="methodset_regexps_highlighting" id="set_regexps_highlighting"><!-- --></a>
2315 <div class="evenrow">
2317 <div class="method-header">
2318 <img src="../../media/images/Method.png" />
2319 <span class="method-title">set_regexps_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1191">1191</a></span>)
2322 <!-- ========== Info from phpDoc block ========= -->
2323 <p class="short-description">Turns highlighting on/off for regexps</p>
2325 <li><span class="field">since:</span> 1.0.0</li>
2328 <div class="method-signature">
2329 <span class="method-result">void</span>
2330 <span class="method-name">
2331 set_regexps_highlighting
2333 (<span class="var-type">int</span> <span class="var-name">$key</span>, <span class="var-type">boolean</span> <span class="var-name">$flag</span>)
2336 <ul class="parameters">
2338 <span class="var-type">int</span>
2339 <span class="var-name">$key</span><span class="var-description">: The key of the regular expression group to turn on or off</span> </li>
2341 <span class="var-type">boolean</span>
2342 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for the regular expression group on or off</span> </li>
2347 <a name="methodset_regexps_style" id="set_regexps_style"><!-- --></a>
2348 <div class="oddrow">
2350 <div class="method-header">
2351 <img src="../../media/images/Method.png" />
2352 <span class="method-title">set_regexps_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1176">1176</a></span>)
2355 <!-- ========== Info from phpDoc block ========= -->
2356 <p class="short-description">Sets the styles for regexps. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
2358 <li><span class="field">since:</span> 1.0.0</li>
2361 <div class="method-signature">
2362 <span class="method-result">void</span>
2363 <span class="method-name">
2366 (<span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">boolean</span> <span class="var-name">$style</span>, [<span class="var-type"></span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
2369 <ul class="parameters">
2371 <span class="var-type">string</span>
2372 <span class="var-name">$key</span><span class="var-description">: The style to make the regular expression matches</span> </li>
2374 <span class="var-type">boolean</span>
2375 <span class="var-name">$style</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
2377 <span class="var-type"></span>
2378 <span class="var-name">$preserve_defaults</span> </li>
2383 <a name="methodset_source" id="set_source"><!-- --></a>
2384 <div class="evenrow">
2386 <div class="method-header">
2387 <img src="../../media/images/Method.png" />
2388 <span class="method-title">set_source</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a645">645</a></span>)
2391 <!-- ========== Info from phpDoc block ========= -->
2392 <p class="short-description">Sets the source code for this object</p>
2394 <li><span class="field">since:</span> 1.0.0</li>
2397 <div class="method-signature">
2398 <span class="method-result">void</span>
2399 <span class="method-name">
2402 (<span class="var-type">string</span> <span class="var-name">$source</span>)
2405 <ul class="parameters">
2407 <span class="var-type">string</span>
2408 <span class="var-name">$source</span><span class="var-description">: The source code to highlight</span> </li>
2413 <a name="methodset_strings_highlighting" id="set_strings_highlighting"><!-- --></a>
2414 <div class="oddrow">
2416 <div class="method-header">
2417 <img src="../../media/images/Method.png" />
2418 <span class="method-title">set_strings_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1103">1103</a></span>)
2421 <!-- ========== Info from phpDoc block ========= -->
2422 <p class="short-description">Turns highlighting on/off for strings</p>
2424 <li><span class="field">since:</span> 1.0.0</li>
2427 <div class="method-signature">
2428 <span class="method-result">void</span>
2429 <span class="method-name">
2430 set_strings_highlighting
2432 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
2435 <ul class="parameters">
2437 <span class="var-type">boolean</span>
2438 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for strings on or off</span> </li>
2443 <a name="methodset_strings_style" id="set_strings_style"><!-- --></a>
2444 <div class="evenrow">
2446 <div class="method-header">
2447 <img src="../../media/images/Method.png" />
2448 <span class="method-title">set_strings_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1089">1089</a></span>)
2451 <!-- ========== Info from phpDoc block ========= -->
2452 <p class="short-description">Sets the styles for strings. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
2454 <li><span class="field">since:</span> 1.0.0</li>
2457 <div class="method-signature">
2458 <span class="method-result">void</span>
2459 <span class="method-name">
2462 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>])
2465 <ul class="parameters">
2467 <span class="var-type">string</span>
2468 <span class="var-name">$style</span><span class="var-description">: The style to make the escape characters</span> </li>
2470 <span class="var-type">boolean</span>
2471 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
2476 <a name="methodset_symbols_highlighting" id="set_symbols_highlighting"><!-- --></a>
2477 <div class="oddrow">
2479 <div class="method-header">
2480 <img src="../../media/images/Method.png" />
2481 <span class="method-title">set_symbols_highlighting</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1071">1071</a></span>)
2484 <!-- ========== Info from phpDoc block ========= -->
2485 <p class="short-description">Turns highlighting on/off for symbols</p>
2487 <li><span class="field">since:</span> 1.0.0</li>
2490 <div class="method-signature">
2491 <span class="method-result">void</span>
2492 <span class="method-name">
2493 set_symbols_highlighting
2495 (<span class="var-type">boolean</span> <span class="var-name">$flag</span>)
2498 <ul class="parameters">
2500 <span class="var-type">boolean</span>
2501 <span class="var-name">$flag</span><span class="var-description">: Whether to turn highlighting for symbols on or off</span> </li>
2506 <a name="methodset_symbols_style" id="set_symbols_style"><!-- --></a>
2507 <div class="evenrow">
2509 <div class="method-header">
2510 <img src="../../media/images/Method.png" />
2511 <span class="method-title">set_symbols_style</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1051">1051</a></span>)
2514 <!-- ========== Info from phpDoc block ========= -->
2515 <p class="short-description">Sets the styles for symbols. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority</p>
2517 <li><span class="field">since:</span> 1.0.1</li>
2520 <div class="method-signature">
2521 <span class="method-result">void</span>
2522 <span class="method-name">
2525 (<span class="var-type">string</span> <span class="var-name">$style</span>, [<span class="var-type">boolean</span> <span class="var-name">$preserve_defaults</span> = <span class="var-default">false</span>], [<span class="var-type">int</span> <span class="var-name">$group</span> = <span class="var-default">0</span>])
2528 <ul class="parameters">
2530 <span class="var-type">string</span>
2531 <span class="var-name">$style</span><span class="var-description">: The style to make the symbols</span> </li>
2533 <span class="var-type">boolean</span>
2534 <span class="var-name">$preserve_defaults</span><span class="var-description">: Whether to merge the new styles with the old or just to overwrite them</span> </li>
2536 <span class="var-type">int</span>
2537 <span class="var-name">$group</span><span class="var-description">: Tells the group of symbols for which style should be set.</span> </li>
2542 <a name="methodset_tab_width" id="set_tab_width"><!-- --></a>
2543 <div class="oddrow">
2545 <div class="method-header">
2546 <img src="../../media/images/Method.png" />
2547 <span class="method-title">set_tab_width</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1231">1231</a></span>)
2550 <!-- ========== Info from phpDoc block ========= -->
2551 <p class="short-description">Sets how many spaces a tab is substituted for</p>
2552 <p class="description"><p>Widths below zero are ignored</p></p>
2554 <li><span class="field">since:</span> 1.0.0</li>
2557 <div class="method-signature">
2558 <span class="method-result">void</span>
2559 <span class="method-name">
2562 (<span class="var-type">int</span> <span class="var-name">$width</span>)
2565 <ul class="parameters">
2567 <span class="var-type">int</span>
2568 <span class="var-name">$width</span><span class="var-description">: The tab width</span> </li>
2573 <a name="methodset_url_for_keyword_group" id="set_url_for_keyword_group"><!-- --></a>
2574 <div class="evenrow">
2576 <div class="method-header">
2577 <img src="../../media/images/Method.png" />
2578 <span class="method-title">set_url_for_keyword_group</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1594">1594</a></span>)
2581 <!-- ========== Info from phpDoc block ========= -->
2582 <p class="short-description">Sets the base URL to be used for keywords</p>
2584 <li><span class="field">since:</span> 1.0.2</li>
2587 <div class="method-signature">
2588 <span class="method-result">void</span>
2589 <span class="method-name">
2590 set_url_for_keyword_group
2592 (<span class="var-type">int</span> <span class="var-name">$group</span>, <span class="var-type">string</span> <span class="var-name">$url</span>)
2595 <ul class="parameters">
2597 <span class="var-type">int</span>
2598 <span class="var-name">$group</span><span class="var-description">: The key of the keyword group to set the URL for</span> </li>
2600 <span class="var-type">string</span>
2601 <span class="var-name">$url</span><span class="var-description">: The URL to set for the group. If {FNAME} is in the url somewhere, it is replaced by the keyword that the URL is being made for</span> </li>
2606 <a name="methodset_use_language_tab_width" id="set_use_language_tab_width"><!-- --></a>
2607 <div class="oddrow">
2609 <div class="method-header">
2610 <img src="../../media/images/Method.png" />
2611 <span class="method-title">set_use_language_tab_width</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1247">1247</a></span>)
2614 <!-- ========== Info from phpDoc block ========= -->
2615 <p class="short-description">Sets whether or not to use tab-stop width specifed by language</p>
2617 <li><span class="field">since:</span> 1.0.7.20</li>
2620 <div class="method-signature">
2621 <span class="method-result">void</span>
2622 <span class="method-name">
2623 set_use_language_tab_width
2625 (<span class="var-type">boolean</span> <span class="var-name">$use</span>)
2628 <ul class="parameters">
2630 <span class="var-type">boolean</span>
2631 <span class="var-name">$use</span><span class="var-description">: Whether to use language-specific tab-stop widths</span> </li>
2636 <a name="methodstart_line_numbers_at" id="start_line_numbers_at"><!-- --></a>
2637 <div class="evenrow">
2639 <div class="method-header">
2640 <img src="../../media/images/Method.png" />
2641 <span class="method-title">start_line_numbers_at</span> (line <span class="line-number"><a href="../../__filesource/fsource_geshi_core_geshi.php.html#a1728">1728</a></span>)
2644 <!-- ========== Info from phpDoc block ========= -->
2645 <p class="short-description">Sets what number line numbers should start at. Should be a positive integer, and will be converted to one.</p>
2646 <p class="description"><p><strong>Warning:</strong> Using this method will add the "start" attribute to the &lt;ol&gt; that is used for line numbering. This is <strong>not</strong> valid XHTML strict, so if that's what you care about then don't use this method. Firefox is getting support for the CSS method of doing this in 1.1 and Opera has support for the CSS method, but (of course) IE doesn't so it's not worth doing it the CSS way yet.</p></p>
2648 <li><span class="field">since:</span> 1.0.2</li>
2651 <div class="method-signature">
2652 <span class="method-result">void</span>
2653 <span class="method-name">
2654 start_line_numbers_at
2656 (<span class="var-type">int</span> <span class="var-name">$number</span>)
2659 <ul class="parameters">
2661 <span class="var-type">int</span>
2662 <span class="var-name">$number</span><span class="var-description">: The number to start line numbers at</span> </li>
2672 <p class="notes" id="credit">
2673 Documentation generated on Thu, 25 Dec 2008 14:34:52 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
projects / platform / framework / web / crosswalk.git / blob