kspread

KSpread Namespace Reference

The KSpread namespace. More...

Namespaces

namespace  CanvasResource
namespace  Format
namespace  NativeFormat
namespace  Odf
namespace  Paste
namespace  Plugins
namespace  Util

Classes

class  AbstractDataManipulator
 Provides an abstract method for the actual setting of new values. More...
class  AbstractDFManipulator
 Extends AbstractDataManipulator with the option of copying cell styles. More...
class  AbstractRegionCommand
 Abstract base class for all region related operations. More...
class  AbstractSelectionStrategy
 An abstract selection strategy. More...
class  AddNamedAreaDialog
class  AddSheetCommand
class  AdjustColumnRowManipulator
 Optimizes the height and the width of rows and columns, respectively. More...
class  AngleDialog
class  ApplicationSettings
 Visual settings. More...
class  ApplyFilterCommand
class  AutoFillCommand
class  AutoFillStrategy
 A strategy for automatic filling values into selected cells. More...
class  AutoFilterCommand
class  AutoFormatCommand
class  AutoFormatDialog
 Dialog for the "Auto-Format..." action. More...
class  Binding
 Abstracts read-only access to the ValueStorage. More...
class  BindingManager
 Manages cell ranges acting as data sources. More...
class  BindingModel
class  BindingStorage
 BindingStorage. More...
class  BitOpsModule
class  Border
class  BorderButton
class  BorderColorCommand
class  BrushSelect
class  CalculationSettings
 Calculation settings. More...
class  CalendarTool
class  CalendarToolFactory
class  CalendarToolWidget
 The CalendarToolWidget class implements a dialog window that allows to define how details about the calendar that should be inserted. More...
class  Canvas
 The scrollable area showing the cells. More...
class  CaseManipulator
 CaseManipulator converts data to uppercase/lowercase/. More...
class  Cell
 An accessor to the actual cell data. More...
class  CellDamage
class  CellEditor
 class CellEditor More...
class  CellFormatDialog
 Dialog for the "Cell Format..." action. More...
class  CellFormatPageBorder
class  CellFormatPageFloat
 Format of numbers. More...
class  CellFormatPageFont
class  CellFormatPagePattern
class  CellFormatPagePosition
class  CellFormatPageProtection
class  CellStorage
 The cell storage. More...
class  CellTool
 The tool to change cell ranges. More...
class  CellToolBase
 Abstract tool providing actions acting on cell ranges. More...
class  CellToolFactory
 The Factory, that creates a CellTool. More...
class  CellView
 Responsible for the painting of Cell. More...
class  ChartDatabaseSelector
 A widget that is shown for selecting the cell region providding the chart data. More...
class  ChartDatabaseSelectorFactory
 factory to create a ChartDatabaseSelector widget More...
class  ChartDialog
 A dialog for showing and altering frame properties. More...
class  Cluster
 This class defines a pointer map to all cells, which makes access to them more performant and additionally limits memory consumption. More...
class  ColumnCluster
 A pointer map to all column formats. More...
class  ColumnFormat
 A column style. More...
class  ColumnHeader
 The widget above the cells showing the column headers. More...
struct  columnSize
class  CommentCommand
 Adds/Removes comments to/of a cell region. More...
class  CommentDialog
class  CommentStorage
struct  Condition
class  Conditional
 Conditional formatting. More...
class  ConditionalDialog
class  ConditionalWidget
class  Conditions
 Manages a set of conditions for a cell. More...
class  ConditionsStorage
 ConditionsStorage. More...
class  CondtionCommand
 Adds/Removes condtional formatting to/of a cell region. More...
class  ConsolidateDialog
class  ConversionModule
class  CSVDataCommand
class  CSVDialog
 Provides dialog for managing CSV (comma separated value) data. More...
class  Currency
class  CustomStyle
 A named cell style. More...
class  Damage
class  Database
 OpenDocument, 8.6.1 Database Range. More...
class  DatabaseDialog
class  DatabaseManager
class  DatabaseModule
class  DatabaseSource
 OpenDocument, 8.6.2 Database Source SQL OpenDocument, 8.6.3 Database Source Table OpenDocument, 8.6.4 Database Source Query. More...
class  DatabaseSourceQuery
 OpenDocument, 8.6.4 Database Source Query. More...
class  DatabaseSourceSql
 OpenDocument, 8.6.2 Database Source SQL. More...
class  DatabaseSourceTable
 OpenDocument, 8.6.3 Database Source Table. More...
class  DatabaseStorage
 DatabaseStorage. More...
class  DataManipulator
 DataManipulator - allows setting values on one range. More...
class  DateTimeModule
class  DefinePrintRangeCommand
class  DeleteCommand
class  DependencyManager
 Manages the dependencies between cells caused by references in formulas. More...
class  Doc
 This class holds the data that makes up a spreadsheet. More...
class  DocumentSettingsDialog
class  DragAndDropStrategy
 A strategy for dragging cells. More...
class  DuplicateSheetCommand
class  EditNamedAreaDialog
class  ElapsedTime
class  EngineeringModule
class  ExternalEditor
class  Factory
class  FillManipulator
 the FillManipulator is used in the Fill operation More...
class  Filter
 OpenDocument, 8.7.1 Table Filter. More...
class  FilterPopup
class  FinancialModule
class  FindDlg
class  FindOption
class  Formula
 Class Formula encapsulates a formula for a cell. More...
class  FormulaDialog
class  FormulaEditorHighlighter
 Colors cell references in formulas. More...
class  FormulaOfCell
class  FormulaStorage
 FormulaStorage. More...
struct  FuncExtra
class  Function
 A function pointer and context. More...
class  FunctionCompletion
 Provides autocompletition facilities in formula editors. More...
class  FunctionDescription
 A function description. More...
class  FunctionModule
 A function module. More...
class  FunctionModuleRegistry
 Registry for function modules. More...
class  FunctionParameter
 A function parameter. More...
class  FunctionRepository
 The function repository. More...
class  FusionStorage
class  GeneralTab
class  GenValidationStyle
class  GenValidationStyles
class  GoalSeekDialog
class  GotoDialog
class  GuiHelper
 A simple class useful for finding out if a series of data object will cause a normal or a tri-state checkbox. More...
class  HideSheetCommand
class  HideShowManipulator
 Hides and shows columns and rows. More...
class  HyperlinkStrategy
 A strategy for visiting a hyperlink. More...
class  IndentationCommand
class  InformationModule
class  InsertDeleteColumnManipulator
 Inserts and deletes rows. More...
class  InsertDeleteRowManipulator
 Inserts and deletes rows. More...
class  InsertDialog
struct  layoutCell
struct  layoutColumn
struct  layoutRow
struct  layoutTextCell
class  LinkCommand
class  LinkDialog
class  LinkStorage
class  ListDialog
class  LoadingInfo
 Temporary information used only during loading. More...
class  Localization
class  LocationComboBox
 LocationComboBox. More...
class  LocationEditWidget
 A widget that allows the user to enter an arbitrary cell location to goto or cell selection to highlight. More...
class  LogicModule
class  Map
 The "embedded document". More...
class  MapAdaptor
 The MapAdaptor class provides additional functionality to deal with sheets. More...
class  MathModule
class  MatrixStorage
class  MergeCommand
 Merges and splits the cells of a cell region. More...
class  MergeStrategy
 A strategy for merging cells. More...
class  NamedAreaCommand
class  NamedAreaDialog
class  NamedAreaManager
 Manages named cell areas. More...
class  NamedStyle
class  OdfLoadingContext
 Data used while loading. More...
class  OdfSavingContext
 Data used while saving. More...
class  PageLayoutCommand
class  PageLayoutDialog
class  PageManager
 Manages printing on the sheet level. More...
class  parameterLocale
class  PasteInsertDialog
class  PasteStrategy
 A strategy for pasting the global mouse selection. More...
class  PatternSelect
class  PointStorage
 A custom pointwise storage. More...
class  PrecisionCommand
class  PreferenceDialog
class  PrintJob
 Manages printing on the document level. More...
class  PrintManager
 Manages printing on the sheet level. More...
class  PrintSettings
 Settings used for printing. More...
struct  rangeInfo
class  ReadOnlyRegionModel
 A model for a contiguous cell region. More...
class  ReadOnlyTableModel
class  ReadWriteTableModel
class  RecalcManager
 Manages the recalculations of cells containing a formula. More...
class  RectStorage
 A custom rectangular storage. More...
class  ReferenceModule
class  Region
 The one for all class for points and ranges. More...
class  RegionSelector
 A minimizable line edit for choosing cell regions. More...
class  RemoveSheetCommand
class  RenameSheetCommand
 Class RenameSheetCommand implements a command for renaming a sheet. More...
class  ResizeColumn
class  ResizeColumnManipulator
 Resize column operation. More...
class  ResizeRow
class  ResizeRowManipulator
 Resize row operation. More...
class  RowCluster
 A pointer map to all row formats. More...
class  RowFormat
 A row style. More...
class  RowHeader
 The widget left to the cells showing the row headers. More...
struct  rowSize
class  RTree
 An R-Tree template. More...
class  ScriptingCellListener
 The ScriptingCellListener class implements a listener to changes within cells of a sheet. More...
class  SearchDlg
class  SelectAllButton
 The widget in the top left corner of the canvas, responsible for selecting all cells in a sheet. More...
class  Selection
 Manages the selection of cells. More...
class  SelectionDamage
class  SelectionStrategy
 A strategy for selecting cell ranges. More...
class  SeriesDialog
class  SeriesManipulator
class  ShapeApplicationData
 KSpread specific data attached to each shape. More...
class  SharedSubStyle
class  Sheet
 A sheet contains several cells. More...
class  SheetAdaptor
class  SheetDamage
class  SheetPrint
class  SheetPropertiesCommand
 Class SheetPropertiesCommand implements a command for changing sheet properties. More...
class  SheetPropertiesDialog
class  SheetPropertiesWidget
class  SheetsEditor
class  SheetSelectPage
 Print dialog page for selecting sheets to print. More...
class  SheetView
 The SheetView controls the painting of the sheets' cells. More...
class  ShiftManipulator
class  ShowColRow
class  ShowDialog
class  ShowSheetCommand
class  SortDialog
class  SortManipulator
 Sorts the range that it gets, using various criteria. More...
class  SpecialPasteDialog
class  SpellCheckCommand
class  StatisticalModule
class  Style
 A cell style. More...
struct  styleCell
class  StyleCommand
 Manipulates the style of a cell region. More...
class  StyleManager
 Manages cell styles The StyleManager takes care of named styles. More...
class  StyleManagerDialog
class  StyleStorage
 The style storage. More...
class  SubStyle
 A single style attribute. More...
class  SubStyleOne
class  SubtotalDialog
class  TabBar
 The TabBar class provides a tab bar, for use to switch active page/sheet in a document. More...
class  TablePageManager
class  TableShape
class  TableTool
class  TableToolFactory
class  TextModule
struct  textOfCell
class  Token
 Token. More...
class  Tokens
 Class Tokens represents array of tokens. More...
class  ToolRegistry
 Registry for tools. More...
class  TrigonometryModule
class  UndoAction
 Abstract base class. More...
class  UndoCellPaste
class  UndoDragDrop
class  UserInputStorage
class  Validity
 Validity checks for cell contents. More...
class  ValidityCommand
 Adds/Removes validity checks to/of a cell region. More...
class  ValidityDialog
class  ValidityStorage
 ValidityStorage. More...
class  Value
 Provides a wrapper for cell value. More...
class  ValueCalc
 The ValueCalc class is used to perform all sorts of calculations. More...
class  ValueConverter
 Converts between the different Value types. More...
class  ValueFormatter
 Generates a textual representation of a Value with a given formatting. More...
class  ValueParser
 Generates a Value by parsing an user input text. More...
class  ValueStorage
 ValueStorage. More...
class  View
 The View class displays a KSpread document. More...
class  ViewAdaptor
 The ViewAdaptor class provides access to a view on a KSpread document. More...
class  WorkbookDamage

Typedefs

typedef void(* arrayWalkFunc )(ValueCalc *, Value &result, Value val, Value param)
typedef QHash< Cell, CellCellIndirection
typedef QMap< QString,
CustomStyle * > 
CustomStyles
typedef Value(* FunctionPtr )(valVector, ValueCalc *, FuncExtra *)
typedef QHash< QString, StyleStyles
typedef QVector< ValuevalVector

Enumerations

enum  BorderShortcutType { BorderShortcutType_Remove = 0, BorderShortcutType_All, BorderShortcutType_Outline, BorderShortcutType_END }
enum  BorderType {
  BorderType_Top = 0, BorderType_Bottom, BorderType_Left, BorderType_Right,
  BorderType_Vertical, BorderType_Horizontal, BorderType_FallingDiagonal, BorderType_RisingDiagonal,
  BorderType_END
}
enum  Comp {
  isEqual, isLess, isGreater, lessEqual,
  greaterEqual, notEqual
}
enum  MethodOfCalc {
  SumOfNumber, Min, Max, Average,
  Count, NoneCalc, CountA
}
enum  ModifyType {
  MT_NONE = 0, MT_MOVE, MT_RESIZE_UP, MT_RESIZE_DN,
  MT_RESIZE_LF, MT_RESIZE_RT, MT_RESIZE_LU, MT_RESIZE_LD,
  MT_RESIZE_RU, MT_RESIZE_RD
}
enum  MoveTo {
  Bottom, Left, Top, Right,
  BottomFirst, NoMovement
}
enum  ParameterType {
  KSpread_Int, KSpread_Float, KSpread_String, KSpread_Boolean,
  KSpread_Any
}
enum  PropValue { STATE_ON = 0, STATE_OFF = 1, STATE_UNDEF = 2 }
enum  ToolEditMode { TEM_MOUSE = 0, INS_OBJECT = 5, INS_DIAGRAMM = 7, INS_PICTURE = 16 }
enum  Type { numeric, string }

Functions

bool approxEqual (double a, double b)
double approxFloor (double a)
Number atg (const Number &n)
Number atgh (const Number &n)
static uint calculateValue (QPen const &pen)
static QString cellAsText (const Cell &cell, bool addTab)
static QString createObjectName (const QString &sheetName)
KSPREAD_EXPORT int days360 (int day1, int month1, int year1, bool leapYear1, int day2, int month2, int year2, bool usa)
KSPREAD_EXPORT int days360 (const QDate &_date1, const QDate &_date2, bool european)
KSPREAD_EXPORT int daysBetweenDates (QDate const &date1, QDate const &date2, int basis)
KSPREAD_EXPORT int daysPerYear (QDate const &date, int basis)
KSPREAD_EXPORT long double duration (const QDate &refDate, const QDate &settlement, const QDate &maturity, const long double &coup_, const long double &yield_, const int &freq, const int &basis, const long double &numOfCoups)
bool isIdentifier (QChar ch)
Number ln (const Number &n)
Number log (const Number &n, Number base)
Token::Op matchOperator (const QString &text)
KAboutData * newAboutData ()
QTextStreamoperator<< (QTextStream &ts, Formula formula)
KSPREAD_EXPORT long double pow1p (const long double &x, const long double &y)
KSPREAD_EXPORT long double pow1pm1 (const long double &x, const long double &y)
uint qHash (const Value &value)
uint qHash (const Formula &formula)
uint qHash (const Cell &cell)
Number tg (const Number &n)
Number tgh (const Number &n)
KSPREAD_EXPORT long double yearFrac (const QDate &refDate, const QDate &startDate, const QDate &endDate, int basis)

Variables

static const char * arrow_left_xpm []
static const char * arrow_leftmost_xpm []
static const char * arrow_right_xpm []
static const char * arrow_rightmost_xpm []
static const char * description = I18N_NOOP("KOffice Spreadsheet Application")
static const char * version = KOFFICE_VERSION_STRING

Detailed Description

The KSpread namespace.


Typedef Documentation

typedef void(* KSpread::arrayWalkFunc)(ValueCalc *, Value &result, Value val, Value param)

Definition at line 58 of file ValueCalc.h.

Definition at line 40 of file Formula.h.

Definition at line 51 of file Style.h.

Definition at line 54 of file Functions.h.

Definition at line 46 of file Style.h.

Definition at line 37 of file Functions.h.


Enumeration Type Documentation

Enumerator:
BorderShortcutType_Remove 
BorderShortcutType_All 
BorderShortcutType_Outline 
BorderShortcutType_END 

Definition at line 90 of file LayoutDialog.h.

Enumerator:
BorderType_Top 
BorderType_Bottom 
BorderType_Left 
BorderType_Right 
BorderType_Vertical 
BorderType_Horizontal 
BorderType_FallingDiagonal 
BorderType_RisingDiagonal 
BorderType_END 

Definition at line 77 of file LayoutDialog.h.

Enumerator:
isEqual 
isLess 
isGreater 
lessEqual 
greaterEqual 
notEqual 

Definition at line 46 of file ValueCalc.h.

Enumerator:
SumOfNumber 
Min 
Max 
Average 
Count 
NoneCalc 
CountA 

Definition at line 133 of file Global.h.

Enumerator:
MT_NONE 
MT_MOVE 
MT_RESIZE_UP 
MT_RESIZE_DN 
MT_RESIZE_LF 
MT_RESIZE_RT 
MT_RESIZE_LU 
MT_RESIZE_LD 
MT_RESIZE_RU 
MT_RESIZE_RD 

Definition at line 135 of file Global.h.

Enumerator:
Bottom 
Left 
Top 
Right 
BottomFirst 
NoMovement 

Definition at line 132 of file Global.h.

Enumerator:
KSpread_Int 
KSpread_Float 
KSpread_String 
KSpread_Boolean 
KSpread_Any 

Definition at line 90 of file Functions.h.

Enumerator:
STATE_ON 
STATE_OFF 
STATE_UNDEF 

Definition at line 148 of file Global.h.

Enumerator:
TEM_MOUSE 
INS_OBJECT 
INS_DIAGRAMM 
INS_PICTURE 

Definition at line 155 of file Global.h.

Enumerator:
numeric 
string 

Definition at line 47 of file ValueCalc.h.


Function Documentation

bool KSpread::approxEqual ( double  a,
double  b 
) [inline]

Definition at line 296 of file ValueCalc.h.

double KSpread::approxFloor ( double  a  )  [inline]

Definition at line 305 of file ValueCalc.h.

Number KSpread::atg ( const Number n  )  [inline]

Definition at line 38 of file Number.h.

Number KSpread::atgh ( const Number n  )  [inline]

Definition at line 40 of file Number.h.

static uint KSpread::calculateValue ( QPen const &  pen  )  [static]

Definition at line 56 of file Style.cpp.

static QString KSpread::cellAsText ( const Cell &  cell,
bool  addTab 
) [static]

Definition at line 1269 of file Sheet.cpp.

static QString KSpread::createObjectName ( const QString sheetName  )  [static]

Definition at line 100 of file Sheet.cpp.

int KSpread::days360 ( int  day1,
int  month1,
int  year1,
bool  leapYear1,
int  day2,
int  month2,
int  year2,
bool  usa 
)

Definition at line 141 of file helper.cpp.

int KSpread::days360 ( const QDate _date1,
const QDate _date2,
bool  european 
)

Definition at line 172 of file helper.cpp.

int KSpread::daysBetweenDates ( QDate const &  date1,
QDate const &  date2,
int  basis 
)

Definition at line 94 of file helper.cpp.

int KSpread::daysPerYear ( QDate const &  date,
int  basis 
)

Definition at line 71 of file helper.cpp.

long double KSpread::duration ( const QDate refDate,
const QDate settlement,
const QDate maturity,
const long double &  coup_,
const long double &  yield_,
const int &  freq,
const int &  basis,
const long double &  numOfCoups 
)

Definition at line 349 of file helper.cpp.

bool KSpread::isIdentifier ( QChar  ch  ) 

helper function: return true for valid identifier character

Definition at line 416 of file Formula.cpp.

Number KSpread::ln ( const Number n  )  [inline]

Definition at line 36 of file Number.h.

Number KSpread::log ( const Number n,
Number  base 
) [inline]

Definition at line 35 of file Number.h.

Token::Op KSpread::matchOperator ( const QString text  ) 

helper function: return operator of given token text e.g.

"*" yields Operator::Asterisk, and so on

Definition at line 134 of file Formula.cpp.

KAboutData* KSpread::newAboutData (  ) 

Definition at line 35 of file AboutData.h.

QTextStream& KSpread::operator<< ( QTextStream ts,
Formula  formula 
)

Dumps the formula, should be used only to assist debugging.

Definition at line 1788 of file Formula.cpp.

long double KSpread::pow1p ( const long double &  x,
const long double &  y 
)

Definition at line 332 of file helper.cpp.

long double KSpread::pow1pm1 ( const long double &  x,
const long double &  y 
)

Definition at line 341 of file helper.cpp.

uint KSpread::qHash ( const Value &  value  ) 
uint KSpread::qHash ( const Formula &  formula  )  [inline]

Definition at line 397 of file Formula.h.

uint KSpread::qHash ( const Cell &  cell  )  [inline]

Definition at line 607 of file Cell.h.

Number KSpread::tg ( const Number n  )  [inline]

Definition at line 37 of file Number.h.

Number KSpread::tgh ( const Number n  )  [inline]

Definition at line 39 of file Number.h.

long double KSpread::yearFrac ( const QDate refDate,
const QDate startDate,
const QDate endDate,
int  basis 
)

Definition at line 245 of file helper.cpp.


Variable Documentation

const char* KSpread::arrow_left_xpm[] [static]
Initial value:
 {
"10 10 2 1",
"   c None",
".  c #000000",
"          ",
"      .   ",
"     ..   ",
"    ...   ",
"   ....   ",
"    ...   ",
"     ..   ",
"      .   ",
"          ",
"          "}

Definition at line 154 of file TabBar.cpp.

const char* KSpread::arrow_leftmost_xpm[] [static]
Initial value:
 {
"10 10 2 1",
"   c None",
".  c #000000",
"          ",
"  .    .  ",
"  .   ..  ",
"  .  ...  ",
"  . ....  ",
"  .  ...  ",
"  .   ..  ",
"  .    .  ",
"          ",
"          "}

Definition at line 122 of file TabBar.cpp.

const char* KSpread::arrow_right_xpm[] [static]
Initial value:
 {
"10 10 2 1",
"   c None",
".  c #000000",
"          ",
"   .      ",
"   ..     ",
"   ...    ",
"   ....   ",
"   ...    ",
"   ..     ",
"   .      ",
"          ",
"          "}

Definition at line 170 of file TabBar.cpp.

const char* KSpread::arrow_rightmost_xpm[] [static]
Initial value:
 {
"10 10 2 1",
"   c None",
".  c #000000",
"          ",
"  .    .  ",
"  ..   .  ",
"  ...  .  ",
"  .... .  ",
"  ...  .  ",
"  ..   .  ",
"  .    .  ",
"          ",
"          "}

Definition at line 138 of file TabBar.cpp.

const char* KSpread::description = I18N_NOOP("KOffice Spreadsheet Application") [static]

Definition at line 30 of file AboutData.h.

const char* KSpread::version = KOFFICE_VERSION_STRING [static]

Definition at line 33 of file AboutData.h.