Located in /mambots/content/geshi/geshi.php (line 100)
constructor: GeSHi
------------------ Creates a new GeSHi object, with source and language
method: add_keyword
------------------- Adds a keyword to a keyword group for highlighting
method: add_keyword_group
------------------------- Creates a new keyword group
method: add_url_to_keyword -------------------------- Adds a url to a keyword where needed.
Added in 1.0.2
method: change_case
------------------- Changes the case of a keyword for those languages where a change is asked for
method: disable_highlighting
---------------------------- Disables all highlighting
method: enable_classes
---------------------- Sets whether CSS classes should be used to highlight the source. Default is off, calling this method with no arguments will turn it on
method: enable_highlighting
--------------------------- Enables all highlighting
method: enable_ids
------------------ Whether CSS IDs should be added to each line
method: enable_important_blocks
------------------------------- Sets whether context-important blocks are highlighted
method: enable_line_numbers
--------------------------- Sets whether line numbers should be displayed. GESHI_NO_LINE_NUMBERS = not displayed, GESHI_NORMAL_LINE_NUMBERS = displayed, GESHI_FANCY_LINE_NUMBERS = every nth line a different class. Default is for no line numbers to be used
method: enable_strict_mode
-------------------------- 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
method: error
------------- Returns an error message associated with the last GeSHi operation, or false if no error has occured
method: finalise ---------------- Takes the parsed code and various options, and creates the HTML surrounding it to make it look nice.
method: footer
-------------- Returns the footer for the code block. Ending newline removed in 1.0.2
method: format_footer_content
----------------------------- Returns the footer content, formatted for output
method: format_header_content
----------------------------- Returns the header content, formatted for output
method: get_attributes
---------------------- Gets the CSS attributes for this code
get_language_name()
--------------- Gets a human-readable language name (thanks to Simon Patterson for the idea :))
method: get_stylesheet
---------------------- 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
method: get_tab_replacement --------------------------- Gets the replacement string for tabs in the source code. Useful for HTML highlighting, where tabs don't mean anything to a browser.
method: get_time
---------------- Gets the time taken to parse the code
method: header
-------------- Creates the header for the code block (with correct attributes)
method: highlight_lines_extra
----------------------------- Specifies which lines to highlight extra
method: indent -------------- Swaps out spaces and tabs for HTML indentation. Not needed if the code is in a pre block...
method: load_language
--------------------- Gets language information and stores it for later use
method: parse_code()
-------------------- Returns the code in $this->source, highlighted and surrounded by the nessecary HTML. 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 <span>s
method: parse_non_string_part ----------------------------- Takes a string that has no strings or comments in it, and highlights stuff like keywords, numbers and methods.
method: remove_keyword
---------------------- Removes a keyword from a keyword group
method: remove_keyword_group
---------------------------- Removes a keyword group
method: replace_keywords
---------------------- Replaces certain keywords in the header and footer with certain configuration values
method: set_brackets_highlighting --------------------------------- Turns highlighting on/off for brackets
This method is DEPRECATED: use set_symbols_highlighting instead. This method will be remove in 1.2.X
method: set_brackets_style
-------------------------- 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
This method is DEPRECATED: use set_symbols_style instead. This method will be removed in 1.2.X
method: set_case_keywords
------------------------- Sets the case that keywords should use when found. Use the constants: GESHI_CAPS_NO_CHANGE: leave keywords as-is GESHI_CAPS_UPPER: convert all keywords to uppercase where found GESHI_CAPS_LOWER: convert all keywords to lowercase where found Method added in 1.0.1
method: set_case_sensitivity
---------------------------- Sets whether a set of keywords are checked for in a case sensitive manner
method: set_code_style
---------------------- Sets the style for the actual code. This should be a string containing valid stylesheet declarations. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
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.
method: set_comments_highlighting
--------------------------------- Turns highlighting on/off for comment groups
method: set_comments_style
-------------------------- 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
method: set_encoding -------------------- Sets the encoding used for htmlentities(), for international support.
method: set_escape_characters_highlighting
------------------------------------------ Turns highlighting on/off for escaped characters
method: set_escape_characters_style
----------------------------------- 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
method: set_footer_content
-------------------------- Sets the content of the footer block
method: set_footer_content_style
-------------------------------- Sets the style for the footer content
method: set_header_content
-------------------------- Sets the content of the header block
method: set_header_content_style
-------------------------------- Sets the style for the header content
method: set_header_type
----------------------- Sets the type of header to be used. 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
method: set_highlight_lines_extra_style
--------------------------------------- Sets the style for extra-highlighted lines
method: set_important_styles
---------------------------- Sets styles for important parts of the code
method: set_keyword_group_highlighting
-------------------------------------- Turns highlighting on/off for a keyword group
method: set_keyword_group_style
------------------------------- 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
method: set_language
-------------------- Sets the language for this object
method: set_language_path
------------------------- 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.
method: set_line_style
---------------------- Sets the styles for the line numbers. This should be a string containing valid stylesheet declarations. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
method: set_link_styles
----------------------- Sets styles for links in code
method: set_link_target
----------------------- Sets the target for links in code
method: set_methods_highlighting
-------------------------------- Turns highlighting on/off for methods
method: set_methods_style
------------------------- Sets the styles for methods. $key is a number that references the 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
method: set_numbers_highlighting
-------------------------------- Turns highlighting on/off for numbers
method: set_numbers_style
------------------------- 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
method: set_overall_class
------------------------- Sets the overall classname for this block of code. This class can then be used in a stylesheet to style this object's output
method: set_overall_id
---------------------- Sets the overall id for this block of code. This id can then be used in a stylesheet to style this object's output
method: set_overall_style
------------------------- 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
method: set_regexps_highlighting
-------------------------------- Turns highlighting on/off for regexps
method: set_regexps_style
------------------------- 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
method: set_source
------------------ Sets the source code for this object
method: set_strings_highlighting
-------------------------------- Turns highlighting on/off for strings
method: set_strings_style
------------------------- 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
method: set_symbols_highlighting
--------------------------------- Turns highlighting on/off for symbols
method: set_symbols_style
-------------------------- 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
method: set_tab_width
--------------------- Sets how many spaces a tab is substituted for This method will probably be re-engineered later to allow customisability in the maximum and minimum number of tabs without mutulating data fields.
method: set_time
---------------- Sets the time taken to parse the code
method: set_url_for_keyword_group
--------------------------------- Sets the base URL to be used for keywords
method: start_line_numbers_at ----------------------------- Sets what number line numbers should start at. Should be a positive integer, and will be converted to one.
Documentation generated on Fri, 4 Mar 2005 13:56:18 +1000 by phpDocumentor 1.3.0RC3