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"> 4 <head> 5 <!-- template designed by Marco Von Ballmoos --> 6 <title></title> 7 <link rel="stylesheet" href="media/stylesheet.css" /> 8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> 9 </head> 10 <body> 11 <a name="top"></a> 12<h2>Full index</h2> 13<h3>Package indexes</h3> 14<ul> 15 <li><a href="elementindex_geshi.html">geshi</a></li> 16</ul> 17<br /> 18<div class="index-letter-menu"> 19 <a class="index-letter" href="elementindex.html#a">a</a> 20 <a class="index-letter" href="elementindex.html#d">d</a> 21 <a class="index-letter" href="elementindex.html#e">e</a> 22 <a class="index-letter" href="elementindex.html#g">g</a> 23 <a class="index-letter" href="elementindex.html#h">h</a> 24 <a class="index-letter" href="elementindex.html#l">l</a> 25 <a class="index-letter" href="elementindex.html#o">o</a> 26 <a class="index-letter" href="elementindex.html#p">p</a> 27 <a class="index-letter" href="elementindex.html#r">r</a> 28 <a class="index-letter" href="elementindex.html#s">s</a> 29</div> 30 31 <a name="a"></a> 32 <div class="index-letter-section"> 33 <div style="float: left" class="index-letter-title">a</div> 34 <div style="float: right"><a href="#top">top</a></div> 35 <div style="clear: both"></div> 36 </div> 37 <dl> 38 <dt class="field"> 39 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 40 <span class="method-title">add_keyword</span> 41 </dt> 42 <dd class="index-item-body"> 43 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodadd_keyword">GeSHi::add_keyword()</a> in geshi.php</div> 44 <div class="index-item-description">Adds a keyword to a keyword group for highlighting</div> 45 </dd> 46 <dt class="field"> 47 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 48 <span class="method-title">add_keyword_group</span> 49 </dt> 50 <dd class="index-item-body"> 51 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodadd_keyword_group">GeSHi::add_keyword_group()</a> in geshi.php</div> 52 <div class="index-item-description">Creates a new keyword group</div> 53 </dd> 54 </dl> 55 <a name="d"></a> 56 <div class="index-letter-section"> 57 <div style="float: left" class="index-letter-title">d</div> 58 <div style="float: right"><a href="#top">top</a></div> 59 <div style="clear: both"></div> 60 </div> 61 <dl> 62 <dt class="field"> 63 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 64 <span class="method-title">disable_highlighting</span> 65 </dt> 66 <dd class="index-item-body"> 67 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methoddisable_highlighting">GeSHi::disable_highlighting()</a> in geshi.php</div> 68 <div class="index-item-description">Disables all highlighting</div> 69 </dd> 70 </dl> 71 <a name="e"></a> 72 <div class="index-letter-section"> 73 <div style="float: left" class="index-letter-title">e</div> 74 <div style="float: right"><a href="#top">top</a></div> 75 <div style="clear: both"></div> 76 </div> 77 <dl> 78 <dt class="field"> 79 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 80 <span class="method-title">enable_classes</span> 81 </dt> 82 <dd class="index-item-body"> 83 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_classes">GeSHi::enable_classes()</a> in geshi.php</div> 84 <div class="index-item-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</div> 85 </dd> 86 <dt class="field"> 87 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 88 <span class="method-title">enable_highlighting</span> 89 </dt> 90 <dd class="index-item-body"> 91 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_highlighting">GeSHi::enable_highlighting()</a> in geshi.php</div> 92 <div class="index-item-description">Enables all highlighting</div> 93 </dd> 94 <dt class="field"> 95 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 96 <span class="method-title">enable_ids</span> 97 </dt> 98 <dd class="index-item-body"> 99 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_ids">GeSHi::enable_ids()</a> in geshi.php</div> 100 <div class="index-item-description">Whether CSS IDs should be added to each line</div> 101 </dd> 102 <dt class="field"> 103 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 104 <span class="method-title">enable_important_blocks</span> 105 </dt> 106 <dd class="index-item-body"> 107 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_important_blocks">GeSHi::enable_important_blocks()</a> in geshi.php</div> 108 <div class="index-item-description">Sets whether context-important blocks are highlighted</div> 109 </dd> 110 <dt class="field"> 111 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 112 <span class="method-title">enable_inner_code_block</span> 113 </dt> 114 <dd class="index-item-body"> 115 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_inner_code_block">GeSHi::enable_inner_code_block()</a> in geshi.php</div> 116 <div class="index-item-description">Sets whether to force a surrounding block around the highlighted code or not</div> 117 </dd> 118 <dt class="field"> 119 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 120 <span class="method-title">enable_keyword_links</span> 121 </dt> 122 <dd class="index-item-body"> 123 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_keyword_links">GeSHi::enable_keyword_links()</a> in geshi.php</div> 124 <div class="index-item-description">Turns linking of keywords on or off.</div> 125 </dd> 126 <dt class="field"> 127 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 128 <span class="method-title">enable_line_numbers</span> 129 </dt> 130 <dd class="index-item-body"> 131 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_line_numbers">GeSHi::enable_line_numbers()</a> in geshi.php</div> 132 <div class="index-item-description">Sets whether line numbers should be displayed.</div> 133 </dd> 134 <dt class="field"> 135 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 136 <span class="method-title">enable_multiline_span</span> 137 </dt> 138 <dd class="index-item-body"> 139 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_multiline_span">GeSHi::enable_multiline_span()</a> in geshi.php</div> 140 <div class="index-item-description">Sets wether spans and other HTML markup generated by GeSHi can span over multiple lines or not. Defaults to true to reduce overhead.</div> 141 </dd> 142 <dt class="field"> 143 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 144 <span class="method-title">enable_strict_mode</span> 145 </dt> 146 <dd class="index-item-body"> 147 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_strict_mode">GeSHi::enable_strict_mode()</a> in geshi.php</div> 148 <div class="index-item-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.</div> 149 </dd> 150 <dt class="field"> 151 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 152 <span class="method-title">error</span> 153 </dt> 154 <dd class="index-item-body"> 155 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methoderror">GeSHi::error()</a> in geshi.php</div> 156 <div class="index-item-description">Returns an error message associated with the last GeSHi operation, or false if no error has occured</div> 157 </dd> 158 </dl> 159 <a name="g"></a> 160 <div class="index-letter-section"> 161 <div style="float: left" class="index-letter-title">g</div> 162 <div style="float: right"><a href="#top">top</a></div> 163 <div style="clear: both"></div> 164 </div> 165 <dl> 166 <dt class="field"> 167 <img src="media/images/Constructor.png" alt="Method" title="Method" /></title> 168 <span class="method-title">GeSHi</span> 169 </dt> 170 <dd class="index-item-body"> 171 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodGeSHi">GeSHi::GeSHi()</a> in geshi.php</div> 172 <div class="index-item-description">Creates a new GeSHi object, with source and language</div> 173 </dd> 174 <dt class="field"> 175 <img src="media/images/Class.png" alt="Class" title="Class" /></title> 176 GeSHi 177 </dt> 178 <dd class="index-item-body"> 179 <div class="index-item-details"><a href="geshi/core/GeSHi.html">GeSHi</a> in geshi.php</div> 180 <div class="index-item-description">The GeSHi Class.</div> 181 </dd> 182 <dt class="field"> 183 <img src="media/images/Page.png" alt="Page" title="Page" /></title> 184 <span class="include-title">geshi.php</span> 185 </dt> 186 <dd class="index-item-body"> 187 <div class="index-item-details"><a href="geshi/core/_geshi.php.html">geshi.php</a> in geshi.php</div> 188 </dd> 189 <dt class="field"> 190 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 191 <span class="const-title">GESHI_ACTIVE</span> 192 </dt> 193 <dd class="index-item-body"> 194 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_ACTIVE">GESHI_ACTIVE</a> in geshi.php</div> 195 <div class="index-item-description">Links in the source in the :active state</div> 196 </dd> 197 <dt class="field"> 198 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 199 <span class="const-title">GESHI_CAPS_LOWER</span> 200 </dt> 201 <dd class="index-item-body"> 202 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_LOWER">GESHI_CAPS_LOWER</a> in geshi.php</div> 203 <div class="index-item-description">Leave keywords found as the case that they are</div> 204 </dd> 205 <dt class="field"> 206 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 207 <span class="const-title">GESHI_CAPS_NO_CHANGE</span> 208 </dt> 209 <dd class="index-item-body"> 210 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_NO_CHANGE">GESHI_CAPS_NO_CHANGE</a> in geshi.php</div> 211 <div class="index-item-description">Lowercase keywords found</div> 212 </dd> 213 <dt class="field"> 214 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 215 <span class="const-title">GESHI_CAPS_UPPER</span> 216 </dt> 217 <dd class="index-item-body"> 218 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_UPPER">GESHI_CAPS_UPPER</a> in geshi.php</div> 219 <div class="index-item-description">Uppercase keywords found</div> 220 </dd> 221 <dt class="field"> 222 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 223 <span class="const-title">GESHI_END_IMPORTANT</span> 224 </dt> 225 <dd class="index-item-body"> 226 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_END_IMPORTANT">GESHI_END_IMPORTANT</a> in geshi.php</div> 227 <div class="index-item-description">The ender for important parts of the source</div> 228 </dd> 229 <dt class="field"> 230 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 231 <span class="const-title">GESHI_FANCY_LINE_NUMBERS</span> 232 </dt> 233 <dd class="index-item-body"> 234 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_FANCY_LINE_NUMBERS">GESHI_FANCY_LINE_NUMBERS</a> in geshi.php</div> 235 <div class="index-item-description">Use fancy line numbers when building the result</div> 236 </dd> 237 <dt class="field"> 238 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 239 <span class="const-title">GESHI_HEADER_DIV</span> 240 </dt> 241 <dd class="index-item-body"> 242 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_DIV">GESHI_HEADER_DIV</a> in geshi.php</div> 243 <div class="index-item-description">Use a "div" to surround the source</div> 244 </dd> 245 <dt class="field"> 246 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 247 <span class="const-title">GESHI_HEADER_NONE</span> 248 </dt> 249 <dd class="index-item-body"> 250 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_NONE">GESHI_HEADER_NONE</a> in geshi.php</div> 251 <div class="index-item-description">Use nothing to surround the source</div> 252 </dd> 253 <dt class="field"> 254 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 255 <span class="const-title">GESHI_HEADER_PRE</span> 256 </dt> 257 <dd class="index-item-body"> 258 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE">GESHI_HEADER_PRE</a> in geshi.php</div> 259 <div class="index-item-description">Use a "pre" to surround the source</div> 260 </dd> 261 <dt class="field"> 262 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 263 <span class="const-title">GESHI_HEADER_PRE_TABLE</span> 264 </dt> 265 <dd class="index-item-body"> 266 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE_TABLE">GESHI_HEADER_PRE_TABLE</a> in geshi.php</div> 267 <div class="index-item-description">Use a "table" to surround the source:</div> 268 </dd> 269 <dt class="field"> 270 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 271 <span class="const-title">GESHI_HEADER_PRE_VALID</span> 272 </dt> 273 <dd class="index-item-body"> 274 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE_VALID">GESHI_HEADER_PRE_VALID</a> in geshi.php</div> 275 <div class="index-item-description">Use a pre to wrap lines when line numbers are enabled or to wrap the whole code.</div> 276 </dd> 277 <dt class="field"> 278 <img src="media/images/Function.png" alt="Function" title="Function" /></title> 279 <span class="method-title">geshi_highlight</span> 280 </dt> 281 <dd class="index-item-body"> 282 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#functiongeshi_highlight">geshi_highlight()</a> in geshi.php</div> 283 <div class="index-item-description">Easy way to highlight stuff. Behaves just like highlight_string</div> 284 </dd> 285 <dt class="field"> 286 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 287 <span class="const-title">GESHI_HOVER</span> 288 </dt> 289 <dd class="index-item-body"> 290 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HOVER">GESHI_HOVER</a> in geshi.php</div> 291 <div class="index-item-description">Links in the source in the :hover state</div> 292 </dd> 293 <dt class="field"> 294 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 295 <span class="const-title">GESHI_LANG_ROOT</span> 296 </dt> 297 <dd class="index-item-body"> 298 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_LANG_ROOT">GESHI_LANG_ROOT</a> in geshi.php</div> 299 <div class="index-item-description">The language file directory for GeSHi</div> 300 </dd> 301 <dt class="field"> 302 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 303 <span class="const-title">GESHI_LINK</span> 304 </dt> 305 <dd class="index-item-body"> 306 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_LINK">GESHI_LINK</a> in geshi.php</div> 307 <div class="index-item-description">Links in the source in the :link state</div> 308 </dd> 309 <dt class="field"> 310 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 311 <span class="const-title">GESHI_NORMAL_LINE_NUMBERS</span> 312 </dt> 313 <dd class="index-item-body"> 314 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_NORMAL_LINE_NUMBERS">GESHI_NORMAL_LINE_NUMBERS</a> in geshi.php</div> 315 <div class="index-item-description">Use normal line numbers when building the result</div> 316 </dd> 317 <dt class="field"> 318 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 319 <span class="const-title">GESHI_NO_LINE_NUMBERS</span> 320 </dt> 321 <dd class="index-item-body"> 322 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_NO_LINE_NUMBERS">GESHI_NO_LINE_NUMBERS</a> in geshi.php</div> 323 <div class="index-item-description">Use no line numbers when building the result</div> 324 </dd> 325 <dt class="field"> 326 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 327 <span class="const-title">GESHI_ROOT</span> 328 </dt> 329 <dd class="index-item-body"> 330 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_ROOT">GESHI_ROOT</a> in geshi.php</div> 331 <div class="index-item-description">The root directory for GeSHi</div> 332 </dd> 333 <dt class="field"> 334 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 335 <span class="const-title">GESHI_SECURITY_PARANOID</span> 336 </dt> 337 <dd class="index-item-body"> 338 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_SECURITY_PARANOID">GESHI_SECURITY_PARANOID</a> in geshi.php</div> 339 <div class="index-item-description">Tells GeSHi to be paranoid about security settings</div> 340 </dd> 341 <dt class="field"> 342 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 343 <span class="const-title">GESHI_START_IMPORTANT</span> 344 </dt> 345 <dd class="index-item-body"> 346 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_START_IMPORTANT">GESHI_START_IMPORTANT</a> in geshi.php</div> 347 <div class="index-item-description">The starter for important parts of the source</div> 348 </dd> 349 <dt class="field"> 350 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 351 <span class="const-title">GESHI_VERSION</span> 352 </dt> 353 <dd class="index-item-body"> 354 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_VERSION">GESHI_VERSION</a> in geshi.php</div> 355 <div class="index-item-description">The version of this GeSHi file</div> 356 </dd> 357 <dt class="field"> 358 <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> 359 <span class="const-title">GESHI_VISITED</span> 360 </dt> 361 <dd class="index-item-body"> 362 <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_VISITED">GESHI_VISITED</a> in geshi.php</div> 363 <div class="index-item-description">Links in the source in the :visited state</div> 364 </dd> 365 <dt class="field"> 366 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 367 <span class="method-title">get_language_name</span> 368 </dt> 369 <dd class="index-item-body"> 370 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_language_name">GeSHi::get_language_name()</a> in geshi.php</div> 371 <div class="index-item-description">Gets a human-readable language name (thanks to Simon Patterson for the idea :))</div> 372 </dd> 373 <dt class="field"> 374 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 375 <span class="method-title">get_language_name_from_extension</span> 376 </dt> 377 <dd class="index-item-body"> 378 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_language_name_from_extension">GeSHi::get_language_name_from_extension()</a> in geshi.php</div> 379 <div class="index-item-description">Given a file extension, this method returns either a valid geshi language name, or the empty string if it couldn't be found</div> 380 </dd> 381 <dt class="field"> 382 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 383 <span class="method-title">get_multiline_span</span> 384 </dt> 385 <dd class="index-item-body"> 386 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_multiline_span">GeSHi::get_multiline_span()</a> in geshi.php</div> 387 <div class="index-item-description">Get current setting for multiline spans, see GeSHi->enable_multiline_span().</div> 388 </dd> 389 <dt class="field"> 390 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 391 <span class="method-title">get_real_tab_width</span> 392 </dt> 393 <dd class="index-item-body"> 394 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_real_tab_width">GeSHi::get_real_tab_width()</a> in geshi.php</div> 395 <div class="index-item-description">Returns the tab width to use, based on the current language and user preference</div> 396 </dd> 397 <dt class="field"> 398 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 399 <span class="method-title">get_stylesheet</span> 400 </dt> 401 <dd class="index-item-body"> 402 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_stylesheet">GeSHi::get_stylesheet()</a> in geshi.php</div> 403 <div class="index-item-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</div> 404 </dd> 405 <dt class="field"> 406 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 407 <span class="method-title">get_time</span> 408 </dt> 409 <dd class="index-item-body"> 410 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_time">GeSHi::get_time()</a> in geshi.php</div> 411 <div class="index-item-description">Gets the time taken to parse the code</div> 412 </dd> 413 </dl> 414 <a name="h"></a> 415 <div class="index-letter-section"> 416 <div style="float: left" class="index-letter-title">h</div> 417 <div style="float: right"><a href="#top">top</a></div> 418 <div style="clear: both"></div> 419 </div> 420 <dl> 421 <dt class="field"> 422 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 423 <span class="method-title">highlight_lines_extra</span> 424 </dt> 425 <dd class="index-item-body"> 426 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodhighlight_lines_extra">GeSHi::highlight_lines_extra()</a> in geshi.php</div> 427 <div class="index-item-description">Specifies which lines to highlight extra</div> 428 </dd> 429 </dl> 430 <a name="l"></a> 431 <div class="index-letter-section"> 432 <div style="float: left" class="index-letter-title">l</div> 433 <div style="float: right"><a href="#top">top</a></div> 434 <div style="clear: both"></div> 435 </div> 436 <dl> 437 <dt class="field"> 438 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 439 <span class="method-title">load_from_file</span> 440 </dt> 441 <dd class="index-item-body"> 442 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodload_from_file">GeSHi::load_from_file()</a> in geshi.php</div> 443 <div class="index-item-description">Given a file name, this method loads its contents in, and attempts</div> 444 </dd> 445 </dl> 446 <a name="o"></a> 447 <div class="index-letter-section"> 448 <div style="float: left" class="index-letter-title">o</div> 449 <div style="float: right"><a href="#top">top</a></div> 450 <div style="clear: both"></div> 451 </div> 452 <dl> 453 <dt class="field"> 454 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 455 <span class="method-title">optimize_keyword_group</span> 456 </dt> 457 <dd class="index-item-body"> 458 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodoptimize_keyword_group">GeSHi::optimize_keyword_group()</a> in geshi.php</div> 459 <div class="index-item-description">compile optimized regexp list for keyword group</div> 460 </dd> 461 </dl> 462 <a name="p"></a> 463 <div class="index-letter-section"> 464 <div style="float: left" class="index-letter-title">p</div> 465 <div style="float: right"><a href="#top">top</a></div> 466 <div style="clear: both"></div> 467 </div> 468 <dl> 469 <dt class="field"> 470 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 471 <span class="method-title">parse_code</span> 472 </dt> 473 <dd class="index-item-body"> 474 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodparse_code">GeSHi::parse_code()</a> in geshi.php</div> 475 <div class="index-item-description">Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.</div> 476 </dd> 477 </dl> 478 <a name="r"></a> 479 <div class="index-letter-section"> 480 <div style="float: left" class="index-letter-title">r</div> 481 <div style="float: right"><a href="#top">top</a></div> 482 <div style="clear: both"></div> 483 </div> 484 <dl> 485 <dt class="field"> 486 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 487 <span class="method-title">remove_keyword</span> 488 </dt> 489 <dd class="index-item-body"> 490 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodremove_keyword">GeSHi::remove_keyword()</a> in geshi.php</div> 491 <div class="index-item-description">Removes a keyword from a keyword group</div> 492 </dd> 493 <dt class="field"> 494 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 495 <span class="method-title">remove_keyword_group</span> 496 </dt> 497 <dd class="index-item-body"> 498 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodremove_keyword_group">GeSHi::remove_keyword_group()</a> in geshi.php</div> 499 <div class="index-item-description">Removes a keyword group</div> 500 </dd> 501 </dl> 502 <a name="s"></a> 503 <div class="index-letter-section"> 504 <div style="float: left" class="index-letter-title">s</div> 505 <div style="float: right"><a href="#top">top</a></div> 506 <div style="clear: both"></div> 507 </div> 508 <dl> 509 <dt class="field"> 510 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 511 <span class="method-title">set_brackets_highlighting</span> 512 </dt> 513 <dd class="index-item-body"> 514 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_brackets_highlighting">GeSHi::set_brackets_highlighting()</a> in geshi.php</div> 515 <div class="index-item-description">Turns highlighting on/off for brackets</div> 516 </dd> 517 <dt class="field"> 518 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 519 <span class="method-title">set_brackets_style</span> 520 </dt> 521 <dd class="index-item-body"> 522 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_brackets_style">GeSHi::set_brackets_style()</a> in geshi.php</div> 523 <div class="index-item-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</div> 524 </dd> 525 <dt class="field"> 526 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 527 <span class="method-title">set_case_keywords</span> 528 </dt> 529 <dd class="index-item-body"> 530 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_case_keywords">GeSHi::set_case_keywords()</a> in geshi.php</div> 531 <div class="index-item-description">Sets the case that keywords should use when found. Use the constants:</div> 532 </dd> 533 <dt class="field"> 534 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 535 <span class="method-title">set_case_sensitivity</span> 536 </dt> 537 <dd class="index-item-body"> 538 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_case_sensitivity">GeSHi::set_case_sensitivity()</a> in geshi.php</div> 539 <div class="index-item-description">Sets whether a set of keywords are checked for in a case sensitive manner</div> 540 </dd> 541 <dt class="field"> 542 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 543 <span class="method-title">set_code_style</span> 544 </dt> 545 <dd class="index-item-body"> 546 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_code_style">GeSHi::set_code_style()</a> in geshi.php</div> 547 <div class="index-item-description">Sets the style for the actual code. This should be a string</div> 548 </dd> 549 <dt class="field"> 550 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 551 <span class="method-title">set_comments_highlighting</span> 552 </dt> 553 <dd class="index-item-body"> 554 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_comments_highlighting">GeSHi::set_comments_highlighting()</a> in geshi.php</div> 555 <div class="index-item-description">Turns highlighting on/off for comment groups</div> 556 </dd> 557 <dt class="field"> 558 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 559 <span class="method-title">set_comments_style</span> 560 </dt> 561 <dd class="index-item-body"> 562 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_comments_style">GeSHi::set_comments_style()</a> in geshi.php</div> 563 <div class="index-item-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</div> 564 </dd> 565 <dt class="field"> 566 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 567 <span class="method-title">set_encoding</span> 568 </dt> 569 <dd class="index-item-body"> 570 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_encoding">GeSHi::set_encoding()</a> in geshi.php</div> 571 <div class="index-item-description">Sets the encoding used for htmlspecialchars(), for international support.</div> 572 </dd> 573 <dt class="field"> 574 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 575 <span class="method-title">set_escape_characters_highlighting</span> 576 </dt> 577 <dd class="index-item-body"> 578 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_escape_characters_highlighting">GeSHi::set_escape_characters_highlighting()</a> in geshi.php</div> 579 <div class="index-item-description">Turns highlighting on/off for escaped characters</div> 580 </dd> 581 <dt class="field"> 582 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 583 <span class="method-title">set_escape_characters_style</span> 584 </dt> 585 <dd class="index-item-body"> 586 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_escape_characters_style">GeSHi::set_escape_characters_style()</a> in geshi.php</div> 587 <div class="index-item-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</div> 588 </dd> 589 <dt class="field"> 590 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 591 <span class="method-title">set_footer_content</span> 592 </dt> 593 <dd class="index-item-body"> 594 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_footer_content">GeSHi::set_footer_content()</a> in geshi.php</div> 595 <div class="index-item-description">Sets the content of the footer block</div> 596 </dd> 597 <dt class="field"> 598 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 599 <span class="method-title">set_footer_content_style</span> 600 </dt> 601 <dd class="index-item-body"> 602 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_footer_content_style">GeSHi::set_footer_content_style()</a> in geshi.php</div> 603 <div class="index-item-description">Sets the style for the footer content</div> 604 </dd> 605 <dt class="field"> 606 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 607 <span class="method-title">set_header_content</span> 608 </dt> 609 <dd class="index-item-body"> 610 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_header_content">GeSHi::set_header_content()</a> in geshi.php</div> 611 <div class="index-item-description">Sets the content of the header block</div> 612 </dd> 613 <dt class="field"> 614 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 615 <span class="method-title">set_header_content_style</span> 616 </dt> 617 <dd class="index-item-body"> 618 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_header_content_style">GeSHi::set_header_content_style()</a> in geshi.php</div> 619 <div class="index-item-description">Sets the style for the header content</div> 620 </dd> 621 <dt class="field"> 622 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 623 <span class="method-title">set_header_type</span> 624 </dt> 625 <dd class="index-item-body"> 626 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_header_type">GeSHi::set_header_type()</a> in geshi.php</div> 627 <div class="index-item-description">Sets the type of header to be used.</div> 628 </dd> 629 <dt class="field"> 630 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 631 <span class="method-title">set_highlight_lines_extra_style</span> 632 </dt> 633 <dd class="index-item-body"> 634 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_highlight_lines_extra_style">GeSHi::set_highlight_lines_extra_style()</a> in geshi.php</div> 635 <div class="index-item-description">Sets the style for extra-highlighted lines</div> 636 </dd> 637 <dt class="field"> 638 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 639 <span class="method-title">set_important_styles</span> 640 </dt> 641 <dd class="index-item-body"> 642 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_important_styles">GeSHi::set_important_styles()</a> in geshi.php</div> 643 <div class="index-item-description">Sets styles for important parts of the code</div> 644 </dd> 645 <dt class="field"> 646 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 647 <span class="method-title">set_keyword_group_highlighting</span> 648 </dt> 649 <dd class="index-item-body"> 650 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_keyword_group_highlighting">GeSHi::set_keyword_group_highlighting()</a> in geshi.php</div> 651 <div class="index-item-description">Turns highlighting on/off for a keyword group</div> 652 </dd> 653 <dt class="field"> 654 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 655 <span class="method-title">set_keyword_group_style</span> 656 </dt> 657 <dd class="index-item-body"> 658 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_keyword_group_style">GeSHi::set_keyword_group_style()</a> in geshi.php</div> 659 <div class="index-item-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</div> 660 </dd> 661 <dt class="field"> 662 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 663 <span class="method-title">set_language</span> 664 </dt> 665 <dd class="index-item-body"> 666 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_language">GeSHi::set_language()</a> in geshi.php</div> 667 <div class="index-item-description">Sets the language for this object</div> 668 </dd> 669 <dt class="field"> 670 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 671 <span class="method-title">set_language_path</span> 672 </dt> 673 <dd class="index-item-body"> 674 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_language_path">GeSHi::set_language_path()</a> in geshi.php</div> 675 <div class="index-item-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.</div> 676 </dd> 677 <dt class="field"> 678 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 679 <span class="method-title">set_line_ending</span> 680 </dt> 681 <dd class="index-item-body"> 682 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_line_ending">GeSHi::set_line_ending()</a> in geshi.php</div> 683 <div class="index-item-description">Sets the line-ending</div> 684 </dd> 685 <dt class="field"> 686 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 687 <span class="method-title">set_line_style</span> 688 </dt> 689 <dd class="index-item-body"> 690 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_line_style">GeSHi::set_line_style()</a> in geshi.php</div> 691 <div class="index-item-description">Sets the styles for the line numbers.</div> 692 </dd> 693 <dt class="field"> 694 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 695 <span class="method-title">set_link_styles</span> 696 </dt> 697 <dd class="index-item-body"> 698 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_link_styles">GeSHi::set_link_styles()</a> in geshi.php</div> 699 <div class="index-item-description">Sets styles for links in code</div> 700 </dd> 701 <dt class="field"> 702 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 703 <span class="method-title">set_link_target</span> 704 </dt> 705 <dd class="index-item-body"> 706 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_link_target">GeSHi::set_link_target()</a> in geshi.php</div> 707 <div class="index-item-description">Sets the target for links in code</div> 708 </dd> 709 <dt class="field"> 710 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 711 <span class="method-title">set_methods_highlighting</span> 712 </dt> 713 <dd class="index-item-body"> 714 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_methods_highlighting">GeSHi::set_methods_highlighting()</a> in geshi.php</div> 715 <div class="index-item-description">Turns highlighting on/off for methods</div> 716 </dd> 717 <dt class="field"> 718 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 719 <span class="method-title">set_methods_style</span> 720 </dt> 721 <dd class="index-item-body"> 722 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_methods_style">GeSHi::set_methods_style()</a> in geshi.php</div> 723 <div class="index-item-description">Sets the styles for methods. $key is a number that references the</div> 724 </dd> 725 <dt class="field"> 726 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 727 <span class="method-title">set_numbers_highlighting</span> 728 </dt> 729 <dd class="index-item-body"> 730 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_numbers_highlighting">GeSHi::set_numbers_highlighting()</a> in geshi.php</div> 731 <div class="index-item-description">Turns highlighting on/off for numbers</div> 732 </dd> 733 <dt class="field"> 734 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 735 <span class="method-title">set_numbers_style</span> 736 </dt> 737 <dd class="index-item-body"> 738 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_numbers_style">GeSHi::set_numbers_style()</a> in geshi.php</div> 739 <div class="index-item-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</div> 740 </dd> 741 <dt class="field"> 742 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 743 <span class="method-title">set_overall_class</span> 744 </dt> 745 <dd class="index-item-body"> 746 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_overall_class">GeSHi::set_overall_class()</a> in geshi.php</div> 747 <div class="index-item-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</div> 748 </dd> 749 <dt class="field"> 750 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 751 <span class="method-title">set_overall_id</span> 752 </dt> 753 <dd class="index-item-body"> 754 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_overall_id">GeSHi::set_overall_id()</a> in geshi.php</div> 755 <div class="index-item-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</div> 756 </dd> 757 <dt class="field"> 758 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 759 <span class="method-title">set_overall_style</span> 760 </dt> 761 <dd class="index-item-body"> 762 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_overall_style">GeSHi::set_overall_style()</a> in geshi.php</div> 763 <div class="index-item-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</div> 764 </dd> 765 <dt class="field"> 766 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 767 <span class="method-title">set_regexps_highlighting</span> 768 </dt> 769 <dd class="index-item-body"> 770 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_regexps_highlighting">GeSHi::set_regexps_highlighting()</a> in geshi.php</div> 771 <div class="index-item-description">Turns highlighting on/off for regexps</div> 772 </dd> 773 <dt class="field"> 774 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 775 <span class="method-title">set_regexps_style</span> 776 </dt> 777 <dd class="index-item-body"> 778 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_regexps_style">GeSHi::set_regexps_style()</a> in geshi.php</div> 779 <div class="index-item-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</div> 780 </dd> 781 <dt class="field"> 782 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 783 <span class="method-title">set_source</span> 784 </dt> 785 <dd class="index-item-body"> 786 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_source">GeSHi::set_source()</a> in geshi.php</div> 787 <div class="index-item-description">Sets the source code for this object</div> 788 </dd> 789 <dt class="field"> 790 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 791 <span class="method-title">set_strings_highlighting</span> 792 </dt> 793 <dd class="index-item-body"> 794 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_strings_highlighting">GeSHi::set_strings_highlighting()</a> in geshi.php</div> 795 <div class="index-item-description">Turns highlighting on/off for strings</div> 796 </dd> 797 <dt class="field"> 798 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 799 <span class="method-title">set_strings_style</span> 800 </dt> 801 <dd class="index-item-body"> 802 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_strings_style">GeSHi::set_strings_style()</a> in geshi.php</div> 803 <div class="index-item-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</div> 804 </dd> 805 <dt class="field"> 806 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 807 <span class="method-title">set_symbols_highlighting</span> 808 </dt> 809 <dd class="index-item-body"> 810 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_symbols_highlighting">GeSHi::set_symbols_highlighting()</a> in geshi.php</div> 811 <div class="index-item-description">Turns highlighting on/off for symbols</div> 812 </dd> 813 <dt class="field"> 814 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 815 <span class="method-title">set_symbols_style</span> 816 </dt> 817 <dd class="index-item-body"> 818 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_symbols_style">GeSHi::set_symbols_style()</a> in geshi.php</div> 819 <div class="index-item-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</div> 820 </dd> 821 <dt class="field"> 822 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 823 <span class="method-title">set_tab_width</span> 824 </dt> 825 <dd class="index-item-body"> 826 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_tab_width">GeSHi::set_tab_width()</a> in geshi.php</div> 827 <div class="index-item-description">Sets how many spaces a tab is substituted for</div> 828 </dd> 829 <dt class="field"> 830 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 831 <span class="method-title">set_url_for_keyword_group</span> 832 </dt> 833 <dd class="index-item-body"> 834 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_url_for_keyword_group">GeSHi::set_url_for_keyword_group()</a> in geshi.php</div> 835 <div class="index-item-description">Sets the base URL to be used for keywords</div> 836 </dd> 837 <dt class="field"> 838 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 839 <span class="method-title">set_use_language_tab_width</span> 840 </dt> 841 <dd class="index-item-body"> 842 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodset_use_language_tab_width">GeSHi::set_use_language_tab_width()</a> in geshi.php</div> 843 <div class="index-item-description">Sets whether or not to use tab-stop width specifed by language</div> 844 </dd> 845 <dt class="field"> 846 <img src="media/images/Method.png" alt="Method" title="Method" /></title> 847 <span class="method-title">start_line_numbers_at</span> 848 </dt> 849 <dd class="index-item-body"> 850 <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodstart_line_numbers_at">GeSHi::start_line_numbers_at()</a> in geshi.php</div> 851 <div class="index-item-description">Sets what number line numbers should start at. Should be a positive integer, and will be converted to one.</div> 852 </dd> 853 </dl> 854 855<div class="index-letter-menu"> 856 <a class="index-letter" href="elementindex.html#a">a</a> 857 <a class="index-letter" href="elementindex.html#d">d</a> 858 <a class="index-letter" href="elementindex.html#e">e</a> 859 <a class="index-letter" href="elementindex.html#g">g</a> 860 <a class="index-letter" href="elementindex.html#h">h</a> 861 <a class="index-letter" href="elementindex.html#l">l</a> 862 <a class="index-letter" href="elementindex.html#o">o</a> 863 <a class="index-letter" href="elementindex.html#p">p</a> 864 <a class="index-letter" href="elementindex.html#r">r</a> 865 <a class="index-letter" href="elementindex.html#s">s</a> 866</div> </body> 867</html>
