lib Library API Documentation

lib Library Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AlphaTableThe table for special alphabets
AlphaTableEntryThe information our AlphaTable contains
BasicElementBasis of every formula element
BracketElementA left and/or right bracket around one child
CharFamilyCommandChanges the char family of a number of elements an their children
CharStyleCommandChanges the char style of a number of elements an their children
CharTableEntryWhat we know about a unicode char
KColorActionAn action whose pixmap is automatically generated from a color
CompatibilityConverter from the other kformula lib string to a loadable dom
ContainerThe document
ContainerHandlerThis class can handle moving and resizing of embedded documents in your class derived from KoView
ContextStyleContains all the style information for the formela
CustomItemsMapA CustomItemsMap associates a custom item to an index Used in the undo/redo info for insert/delete text
DocumentA document that can contain a lot of formulas (container)
DocumentWrapperA Wrapper that constracts the actions and must be given a real document to work with
ElementCreationStrategyAn object of this type needs to be known by the SequenceElement
ElementIndexA type that describes an index
ElementTypeBasis of all types
ElementVisitorVisitor
EmptyElementAn element that represents an empty box
EventHandlerAn abstract base class for event handlers
KFCAddBase for all commands that want to add a simple element
KFCAddGenericIndexAdd an index
KFCAddIndexAdd an IndexElement
KFCAddReplacingThe command that takes the main child out of the selected element and replaces the element with it
KFCRemoveCommand that is used to remove the currently selected element
KFCRemoveEnclosingCommand to remove the parent element
KFCRemoveSelectionCommand that is used to remove the current selection if we want to replace it with another element
KFCReplaceRemoves the current selection and adds any new elements afterwards
FontCommandBase for all font commands that act on the current selection
FontStyleBase class for all supported font styles
FormulaCursorThe selection
FormulaCursor::CursorDataA black box that is supposed to contain everything which is needed to describe a cursor
FormulaDocumentThe interface the elements expect from its document
FormulaElementThe main element
FormulaListSmall utility class representing a sortable (by x,y position) list of formulas you can use sort() and inSort(item)
KFormulaWidgetThe view
FractionElementA fraction
IndexElementThe element with up to four indexes in the four corners
InternFontTableThe struct used to store static font data
MathML2KFormulaThis class converts MathML to KFormula XML
MatrixDialogDialog for entering matrix sizes
MatrixElementA matrix
MultiElementTypeBasis for all tokens that run along several elements
MultilineElementAny number of lines
NameSequenceThe sequence thats a name
NameTypeA recognized name
NumberTypeA range of elements that make up a number
KoApplicationBase class for all KOffice apps Base class for all KOffice apps
KoApplicationIfaceDCOP interface for any KOffice application (entry point)
KoBorderThis class represents a border - for anything, like paragraph, or frame
KoChangeVariableFormatPropertiesCommand created when changing the properties of a variable's format (e.g
KoChangeVariableSubTypeCommand created when changing the subtype of a variable (turning "fixed date" into "variable date")
KoChildKoChild is an abstract base class that represents the geometry associated with an embedded document
KoColumnsStructure for columns
KoCommandHistoryThe command history stores a (user) configurable amount of Commands. History of user commands (for undo/redo)
KoContextHelpActionKoContextHelpAction provides a easy to use context help system
KoContextHelpPopupKoContextHelpPopup is the popup displayed by ContextHelpAction
KoCustomVarDialogClass: KoCustomVarDialog This dialog allows to add a new custom variable or to edit an existing one
KoCustomVariableA custom variable is a variable whose value is entered by the user
KoCustomVariablesDiaClass: KoCustomVariablesDia This dialog allows to set the value of the custom variables
KoCustomVariablesListClass: KoCustomVariablesList The listview
KoCustomVariablesListItemClass: KoCustomVariablesListItem Used by KoCustomVariablesDia Represents an item in the listview, holding a lineedit to edit the value of the variable
KoDateVariableDate-related variables
KoDocumentThe KOffice document class The KOffice document class
KoDocumentChildHolds an embedded object
KoDocumentEntryRepresents an available KOffice component that supports the document interface
KoDocumentIfaceDCOP interface for any KOffice document Use KoApplicationIface to get hold of an existing document's interface, or to create a document
KoEmbeddingFilterThe base class for all import filters embedding other filters
KoFieldVariableAny variable that is a string, and whose value is automatically determined - as opposed to custom variables whose value is entered by the user
KoFilterThe base class for import and export filters
KoFilterChainThis class represents a chain of plain KoFilter instances
KoFilterEntryRepresents an available filter
KoFilterManagerThis class manages all filters for a KOffice application. The class managing all the filters. KoFilter
KoFindReplaceThis class implements the 'find' functionality ( the "search next, prompt" loop ) and the 'replace' functionality
KoFontChooserThe embeddable font chooser widget
KoFormatDiaThe separate dialog that pops up to ask for which formatting options should be used to match text, or when replacing text
KoHeadFootStructure for header-footer
KoHyphenatorInterface to the libhnj hyphenation library
KoIndentSpacingWidgetThe widget for editing idents and spacings (tab 1)
KoInsertLinkDiaDialog to insert links to various sources (file, Internet, mail and bookmarks)
KoKWHeaderFooterStructure for KWord header-footer
KoMainWindowThis class is used to represent a main window of a KOffice component. Main window for a KOffice application
KoPageLayoutThis structure defines the page layout, including its size in pt, its format (e.g
KoPageLayoutDiaWith this dialog the user can specify the layout of the paper during printing
KoPagePreviewKoPagePreview
KoParagAlignWidgetThe widget for editing paragraph alignment (tab 2)
KoParagBorderWidgetThe widget for editing paragraph borders (tab 3)
KoParagCounterThis is the structure associated with a paragraph (KoTextParag), to define the bullet or numbering of the paragraph
KoParagCounterWidgetThe widget for editing counters (bullets & numbering) (tab 4)
KoParagDiaThe complete(*) dialog for changing attributes of a paragraph
KoParagFormatCommandCommand created when changing the default format of paragraphs
KoParagLayoutThis class holds the paragraph-specific formatting information It's separated from KoTextParag so that it can be copied in the undo/redo history, and in KoStyle
KoParagLayoutWidgetThis is the base class for any widget [usually used in a tab] that handles modifying a part of a KoParagLayout
KoParagTabulatorsWidgetThe widget for editing tabulators (tab 5)
KoParagVisitorBase class for "visitors"
KoPartSelectActionAn action for inserting an embedded object
KoPartSelectDiaThis dialog presents the user all available KOffice components ( KSpread, KWord etc ) with name and mini icon
KoPgNumVariable"current page number" and "number of pages" variables This is a base class, it must be inherited by applications, to provide recalc()
KoPictureKoPicture is a container class for various types of images supported by KOffice. An image container class
KoPictureCollectionA collection of pictures (a key and the picture itself)
KoPictureFilePreviewA preview widget for KFileDialog that supports both pixmaps and cliparts
KoPictureKeyKoPictureKey is the structure describing an image in a unique way. Structure describing an image on disk
KoPointA point whose coordinates are floating-point values ( "double"s )
OrdinaryCreationStrategyThe ordinary strategy to be used for plain kformula
KoRectA rect whose coordinates are floating-point values ( "double"s )
KoRulerKoRuler is the horizontal or vertical ruler, to be used around the drawing area of most KOffice programs
KoSizeA size whose coordinates are floating-point values ( "double"s )
KoSpellKDE Spellchecker
KOSpellConfigA configuration class/dialog for KSpell
KoStoreSaves and loads KOffice documents using various backends
KoStoreDeviceThis class implements a QIODevice around KoStore, so that it can be used to create a QDomDocument from it, or to be read using QDataStream
KoStoreDragA generic drag object that holds a store (e.g
KoStyleA style is a combination of formatting attributes (font, color, etc.) and paragraph-layout attributes, all grouped under a name
KoStylePreviewKoStylePreview
KoTabulatorStruct: KoTabulator Defines the position of a tabulation (in pt), and its type
KoTCDIconCanvasOur reimplementation of KIconCanvas used within the template-chooser dialog
KoTCDRecentFilesIconViewOur reimplementation of KFileIconView used as the "recent files" view within the template-chooser dialog
KoTemplateChooseDiaThis class is used to show the template dialog on startup. The template choose dialog
KoTextCommandWraps a KoTextDocCommand into a KCommand, for the UI In fact the KoTextDocCommand isn't even known from here
KoTextDeleteCommandCommand created when deleting some text
KoTextFindReimplement KFind to provide our own validateMatch - for the formatting options
KoTextFormatEach character (KoTextStringChar) points to a KoTextFormat that defines the formatting of that character (font, bold, italic, underline, misspelled etc.)
KoTextFormatCommandCommand created when changing formatted text
KoTextFormatInterfaceThe KoTextFormatInterface is a pure interface that allows access to the "current text format"
KoTextFormatterWe implement our own text formatter to implement WYSIWYG: It is heavily based on KoTextFormatterBaseBreakWords, but stores the x position of characters (and their width) in pixels, whereas all the rest is in L.U
KoTextInsertCommandCommand created when inserting some text
KoTextIteratorA convenient way to iterate over paragraphs, possibly in multiple textobjects, with many options (from cursor, backwards, in selection). General purpose paragraph iterator
KoTextObjectThe KoTextObject is the high-level object that contains a KoTextDocument (the list of paragraphs), and takes care of the operations on it (particularly the undo/redo commands)
KoTextObject::UndoRedoInfoThe undo-redo structure holds the _temporary_ information for the current undo/redo command
KoTextParagCommandCommand created when changing paragraph attributes
KoTextReplaceReimplement KoReplace to provide our own validateMatch - for the formatting options
KoTextViewObject that is created to edit a KoTextObject
KoTextZoomHandlerA KoTextZoomHandler converts between an internal text layout resolution of ~1440 DPI (by default) and the point-size for the fonts (those known by the user)
KoTimeVariableTime-related variables
KoUnitKOffice stores everything in pt (using "double") internally
KoVariableA KoVariable is a custom item, i.e
KoVariableDateFormatImplementation of the "date" formats TODO: merge with KoVariableTimeFormat, for a single QDateTime-based class
KoVariableFormatClass: KoVariableFormat Base class for a variable format - held by KWDocument
KoVariableFormatCollectionThe collection of formats for variables
KoVariableStringFormatImplementation of the string format
KoVariableTimeFormatImplementation of the "time" formats
OverlineElementA line above the content
KoViewThis class is used to display a KoDocument
KoViewChildThis class aggregates information about an embedded document
KoWmfFuncStatic data
KoWmfHandleWMF file allows manipulation on a stack of object
KoWmfPaintKoWmfPaint inherits the abstract class KoWmfRead and redirects WMF actions onto a QPaintDevice
KoWmfReadKoWmfRead allows the redirection of the actions stored in a WMF file
KoWmfReadPrivateKoWmfReadPrivate allows to read WMF files
KoWmfWriteKoWmfWrite allows to create a windows placeable meta file (WMF)
KoZoomHandlerThis class handles the zooming and DPI stuff (conversions between pt values and pixels)
PartMoveHandlerUsed by ContainerHandler internally to handle moving of embedded documents
PartResizeHandlerUsed by ContainerHandler internally to handle resizing of embedded documents
PlainCommandBase for all kformula commands
KOffice::PriorityQueue< T >This PriorityQueue class is implemented as "upside down" heap, i.e
QWinMetaFileQWinMetaFile is a WMF viewer based on QT toolkit How to use QWinMetaFile :
RootElementA nice graphical root
SequenceElementThe element that contains a number of children
SequenceParserThe parser that gets the element list and returns a syntax tree
SequenceTypeThe token that belongs to a sequence
SingleContentElementThe base of (all) elements that contain just one content element
SingleElementTypeBasis for all tokens that consist of one element only
KSInterpreterThis class offers the API to koscript functionality
KSLocaleThis locale is used when executing external KoScript scripts
KSMethodA method holds a reference to some instance and some function
KSModuleAn instance of this class represents a loaded module
SpaceElementA element that represents a space
KSParseNodeExtraDerive from this class to store extra data in some parsenode
KSSharedPtr< T >Can be used to control the lifetime of an object that has derived QShared
KSUtilUtility functions for checking arguments and creating exceptions
KSValueThis class acts like a union
SVGPathParserParser for svg path data, contained in the d attribute
SymbolElementA symbol is simply a piece of art
SymbolFontHelperWe expect to always have the symbol font
SymbolFontStyleThe style of the standard symbol font
SymbolTableThe symbol table
TextElementAn element that represents one char
TextTypeA text element that doesn't belong to an name
UnderlineElementA line below the content
ViewThe view that shows the formula
KDE Logo
This file is part of the documentation for lib Library Version 1.3.5.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Nov 17 06:54:21 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003