calligra/sheets/Mainpage.dox

0001 /**
0002  * \mainpage Sheets
0003  * Sheets is a scriptable spreadsheet program which provides both
0004  * table-oriented sheets and support for complex mathematical formulas
0005  * and statistics.
0006  *
0007  * \section majorclasses Major classes
0008  * \li KSpread::Canvas The scrollable area showing the cells.
0009  * \li KSpread::Cell Represents a cell in the spreadsheet.
0010  * \li KSpread::Doc The KPart used in Sheets itself and when embedded in non-Calligra applications.
0011  * \li KSpread::Map The actual spreadsheet document consisting of at least one sheet.
0012  * \li KSpread::Sheet A sheet consists of several cells.
0013  * \li KSpread::View This class displays the KPart document.
0014  *
0015  * \section plugins Plugins
0016  * \li \ref KSpreadScripting Sheets Scripting Plugin that offers flexible access
0017  *      to the Kross scripting framework.
0018  * \li CalendarTool Plugin for inserting a calendar into a spreadsheet.
0019  */
0020
0021 /* NOTE Stefan:
0022         Use doxygen's 'ingroup' command for each method/class/namespace
0023         explicitly. This way one sees immediately to which group the method
0024         belongs, if one looks directly into the header file.
0025         Don't group member function together and use 'addgroup'.
0026 */
0027
0028 /**
0029  * \defgroup Damages Damage System
0030  * Classes and methods related to the damage system.
0031  */
0032
0033 /**
0034  * \defgroup OpenDocument OpenDocument file format
0035  * Classes and methods related to the OpenDocument loading/saving.
0036  */
0037
0038 /**
0039  * \defgroup Model Data Models
0040  * Classes and methods related to data models.
0041  */
0042
0043 /**
0044  * \defgroup NativeFormat Old native file format
0045  * Classes and methods related to the Sheets's old native file format loading/saving.
0046  */
0047
0048 /**
0049  * \defgroup Painting Painting System
0050  * Classes and methods related to the painting of cells and objects.
0051  * \ref painting
0052  */
0053
0054 /**
0055  * \defgroup Plugin Plugin System
0056  * Classes and methods related to plugins.
0057  */
0058
0059 /**
0060  * \defgroup Embedding Object Embedding
0061  * Classes and methods related to the embedding of objects (charts, pictures, ...).
0062  */
0063
0064 /**
0065  * \defgroup Storage Storage System
0066  * Classes and methods related to data storage.
0067  */
0068
0069 /**
0070  * \defgroup Style Style System
0071  * Classes and methods related to cell styles.
0072  */
0073
0074 /**
0075  * \defgroup Value Value System
0076  * Classes and methods related to cell values.
0077  */
0078
0079 /**
0080  * \defgroup ColumnRowFormat Column/Row Formats
0081  * Classes and methods related to column/row formats.
0082  */
0083
0084 /**
0085  * \defgroup Page Page Layout
0086  * Classes and methods related to page layouting.
0087  */
0088
0089 /**
0090  * \defgroup Coordinates Coordinate Systems
0091  * Classes and methods related to document/view/cell coordinates.
0092  */
0093
0094 /**
0095  * \defgroup Commands Commands
0096  * Classes and methods related to commands.
0097  */
0098
0099 /**
0100  * \defgroup UI User Interface
0101  * Classes and methods related to the user interface.
0102  */
0103
0104 #EXAMPLE_PATH=. doc
0105 #EXAMPLE_RECURSIVE=NO
0106
0107 // DOXYGEN_SET_PROJECT_NAME = Sheets