#include <latexgen.h>
Static Public Member Functions | |
static void | init () |
static void | writeStyleSheetFile (QFile &f) |
static void | writeHeaderFile (QFile &f) |
static void | writeFooterFile (QFile &f) |
Private Member Functions | |
LatexGenerator (const LatexGenerator &) | |
LatexGenerator & | operator= (const LatexGenerator &) |
Private Attributes | |
bool | insideTabbing |
bool | firstDescItem |
bool | disableLinks |
QCString | relPath |
int | m_indent |
bool | templateMemberItem |
bool | m_prettyCode |
LatexCodeGenerator | m_codeGen |
Additional Inherited Members | |
Public Types inherited from OutputGenerator | |
enum | OutputType { Html, Latex, Man, RTF, XML, DEF, Perl } |
Public Types inherited from BaseOutputDocInterface | |
enum | ParamListTypes { Param, RetVal, Exception } |
enum | SectionTypes { EnumValues, Examples } |
Protected Attributes inherited from OutputGenerator | |
FTextStream | t |
QFile * | file |
QCString | fileName |
QCString | dir |
bool | active |
QStack< bool > * | genStack |
Generator for LaTeX output.
Definition at line 70 of file latexgen.h.
LatexGenerator::LatexGenerator | ( | ) |
Definition at line 246 of file latexgen.cpp.
LatexGenerator::~LatexGenerator | ( | ) |
Definition at line 258 of file latexgen.cpp.
|
private |
|
virtual |
Implements BaseOutputDocInterface.
Definition at line 1648 of file latexgen.cpp.
|
inlinevirtual |
void LatexGenerator::clearBuffer | ( | ) |
|
inlinevirtual |
Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.
Implements CodeOutputInterface.
Definition at line 93 of file latexgen.h.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Writes an ASCII string to the output. Converts characters that have A special meaning, like &
in html.
Implements BaseOutputDocInterface.
Definition at line 1713 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
End a section of text displayed in bold face.
Implements BaseOutputDocInterface.
Definition at line 205 of file latexgen.h.
|
virtual |
Implements OutputGenerator.
Definition at line 1928 of file latexgen.cpp.
|
inlinevirtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1732 of file latexgen.cpp.
|
virtual |
Ends a source code fragment
Implements BaseOutputDocInterface.
Definition at line 2105 of file latexgen.cpp.
|
inlinevirtual |
Ends a line of code started with startCodeLine()
Implements CodeOutputInterface.
Definition at line 107 of file latexgen.h.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 2081 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Ends an item of a description list and starts the description itself: e.g. </dt>
in HTML.
Implements BaseOutputDocInterface.
Definition at line 1959 of file latexgen.cpp.
|
inline |
Definition at line 235 of file latexgen.h.
|
virtual |
Ends a description list: e.g. </dl>
in HTML
Implements BaseOutputDocInterface.
Definition at line 1947 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1937 of file latexgen.cpp.
|
virtual |
Implements OutputGenerator.
Definition at line 1901 of file latexgen.cpp.
|
virtual |
|
inlinevirtual |
Ends a section of text displayed in italic.
Implements BaseOutputDocInterface.
Definition at line 203 of file latexgen.h.
|
virtual |
Implements OutputGenerator.
Definition at line 809 of file latexgen.cpp.
|
inlinevirtual |
Ends a block started with startFontClass()
Implements CodeOutputInterface.
Definition at line 111 of file latexgen.h.
|
virtual |
Implements OutputGenerator.
Definition at line 1919 of file latexgen.cpp.
|
virtual |
|
inlinevirtual |
|
virtual |
Ends a link started by startHtmlLink().
Implements BaseOutputDocInterface.
Definition at line 1323 of file latexgen.cpp.
|
virtual |
Implements OutputGenerator.
Definition at line 1910 of file latexgen.cpp.
|
inlinevirtual |
|
virtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1000 of file latexgen.cpp.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
Ends a bullet list: e.g. </ul>
in html
Implements BaseOutputDocInterface.
Definition at line 150 of file latexgen.h.
|
inlinevirtual |
Writes a list item for a bullet or enumerated list: e.g. </li>
in html
Implements BaseOutputDocInterface.
Definition at line 166 of file latexgen.h.
|
virtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1881 of file latexgen.cpp.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 2021 of file latexgen.cpp.
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Implements BaseOutputDocInterface.
Definition at line 1399 of file latexgen.cpp.
|
inlinevirtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1458 of file latexgen.cpp.
|
inlinevirtual |
End a section of text displayed in typewriter style.
Implements BaseOutputDocInterface.
Definition at line 162 of file latexgen.h.
|
virtual |
|
inlinevirtual |
|
static |
Definition at line 437 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
void LatexGenerator::newParagraph | ( | ) |
Definition at line 1267 of file latexgen.cpp.
|
private |
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
Changes the text font to bold face. The bold section ends with endBold()
Implements BaseOutputDocInterface.
Definition at line 204 of file latexgen.h.
|
virtual |
|
inlinevirtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1726 of file latexgen.cpp.
|
virtual |
Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()
Implements BaseOutputDocInterface.
Definition at line 2100 of file latexgen.cpp.
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 2067 of file latexgen.cpp.
|
virtual |
Implements OutputGenerator.
Definition at line 2076 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Starts an item of a description list: e.g. <dt>
in HTML.
Implements BaseOutputDocInterface.
Definition at line 1953 of file latexgen.cpp.
|
inline |
Definition at line 234 of file latexgen.h.
|
virtual |
Starts a description list: e.g. <dl>
in HTML Items are surrounded by startDescItem() and endDescItem()
Implements BaseOutputDocInterface.
Definition at line 1942 of file latexgen.cpp.
|
inlinevirtual |
Implements BaseOutputDocInterface.
Definition at line 263 of file latexgen.h.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
Changes the text font to italic. The italic section ends with endEmphasis()
Implements BaseOutputDocInterface.
Definition at line 202 of file latexgen.h.
|
virtual |
Implements OutputGenerator.
Definition at line 795 of file latexgen.cpp.
|
inlinevirtual |
Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.
clsName | The category name. |
Implements CodeOutputInterface.
Definition at line 109 of file latexgen.h.
|
virtual |
|
virtual |
|
inlinevirtual |
|
virtual |
Starts a (link to an) URL found in the documentation.
url | The URL to link to. |
Implements BaseOutputDocInterface.
Definition at line 1312 of file latexgen.cpp.
|
virtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Implements OutputGenerator.
Definition at line 825 of file latexgen.cpp.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
Start of a bullet list: e.g. <ul>
in html. startItemListItem() is Used for the bullet items.
Implements BaseOutputDocInterface.
Definition at line 149 of file latexgen.h.
|
inlinevirtual |
Writes a list item for a bullet or enumerated list: e.g. <li>
in html
Implements BaseOutputDocInterface.
Definition at line 165 of file latexgen.h.
|
virtual |
|
inlinevirtual |
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1534 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
Implements OutputGenerator.
Definition at line 2139 of file latexgen.cpp.
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 1876 of file latexgen.cpp.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
Implements BaseOutputDocInterface.
Definition at line 1426 of file latexgen.cpp.
|
virtual |
Starts a new paragraph
Starts a new paragraph
Implements BaseOutputDocInterface.
Definition at line 1272 of file latexgen.cpp.
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 2026 of file latexgen.cpp.
|
virtual |
|
virtual |
|
virtual |
Implements OutputGenerator.
Definition at line 820 of file latexgen.cpp.
|
inlinevirtual |
|
virtual |
Implements BaseOutputDocInterface.
Definition at line 1670 of file latexgen.cpp.
|
virtual |
Implements BaseOutputDocInterface.
Definition at line 1972 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
Changes the text font to fixed size. The section ends with endTypewriter()
Implements BaseOutputDocInterface.
Definition at line 161 of file latexgen.h.
|
virtual |
|
virtual |
Writes a single ASCII character to the output. Converts characters that have a special meaning.
Implements BaseOutputDocInterface.
Definition at line 1718 of file latexgen.cpp.
|
inlinevirtual |
Write an anchor to a source listing.
name | The name of the anchor. |
Implements CodeOutputInterface.
Definition at line 113 of file latexgen.h.
|
inlinevirtual |
Writes a link to an object in a code fragment.
ref | If this is non-zero, the object is to be found in an external documentation file. |
file | The file in which the object is located. |
anchor | The anchor uniquely identifying the object within the file. |
name | The text to display as a placeholder for the link. |
tooltip | The tooltip to display when the mouse is on the link. |
Implements CodeOutputInterface.
Definition at line 95 of file latexgen.h.
|
virtual |
Implements OutputGenerator.
Definition at line 2051 of file latexgen.cpp.
|
virtual |
|
inlinevirtual |
|
static |
Definition at line 781 of file latexgen.cpp.
|
inlinevirtual |
|
static |
Definition at line 770 of file latexgen.cpp.
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
Writes the line number of a source listing
ref | External reference (when imported from a tag file) |
file | The file part of the URL pointing to the docs. |
anchor | The anchor part of the URL pointing to the docs. |
lineNumber | The line number to write |
Implements CodeOutputInterface.
Definition at line 99 of file latexgen.h.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
Writes a link to an object in the documentation.
ref | If this is non-zero, the object is to be found in an external documentation file. |
file | The file in which the object is located. |
anchor | The anchor uniquely identifying the object within the file. |
name | The text to display as a placeholder for the link. |
Implements BaseOutputDocInterface.
Definition at line 1404 of file latexgen.cpp.
|
virtual |
|
inlinevirtual |
|
inlinevirtual |
Writes a horizontal ruler to the output
Implements BaseOutputDocInterface.
Definition at line 198 of file latexgen.h.
|
inlinevirtual |
|
inlinevirtual |
|
virtual |
|
virtual |
Writes an ASCII string to the output, without converting special characters.
Implements BaseOutputDocInterface.
Definition at line 1282 of file latexgen.cpp.
|
virtual |
Implements OutputGenerator.
Definition at line 1257 of file latexgen.cpp.
|
static |
Definition at line 788 of file latexgen.cpp.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Writes a tool tip definition
id | unique identifier for the tooltip |
docInfo | Info about the symbol's documentation. |
decl | full declaration of the symbol (for functions) |
desc | brief description for the symbol |
defInfo | Info about the symbol's definition in the source code |
declInfo | Info about the symbol's declaration in the source code |
Implements CodeOutputInterface.
Definition at line 101 of file latexgen.h.
|
private |
Definition at line 338 of file latexgen.h.
|
private |
Definition at line 337 of file latexgen.h.
|
private |
Definition at line 336 of file latexgen.h.
|
private |
Definition at line 343 of file latexgen.h.
|
private |
Definition at line 340 of file latexgen.h.
|
private |
Definition at line 342 of file latexgen.h.
|
private |
Definition at line 339 of file latexgen.h.
|
private |
Definition at line 341 of file latexgen.h.