kspread

KSpread Namespace Reference


Detailed Description

The KSpread namespace.


Classes

class  UndoWrapperCommand
 Class UndoWrapperCommand is used to help migration from custom UndoAction to KCommand-based system. More...
class  MergeCellCommand
 Class MergeCellCommand implements a command for merging two or more cells into one cell. More...
class  DissociateCellCommand
 Class DissociateCellCommand implements a command for breaking merged cells. More...
class  RenameSheetCommand
 Class RenameSheetCommand implements a command for renaming a sheet. More...
class  SheetPropertiesCommand
 Class SheetPropertiesCommand implements a command for changing sheet properties. More...
struct  RangeDependency
 Range dependency - stores information about one dependency of one cell on one range of cells. More...
class  DependencyManager
 This class manages dependencies. More...
class  CSVDialog
 Provides dialog for managing CSV (comma separated value) data. More...
class  FormatDialog
 Dialog for the "AutoFormat..." action. More...
class  CellFormatPageFloat
 Format of numbers. More...
class  CellFormatDialog
 Dialog for the "Cell Format..." action. More...
class  Token
 Token. More...
class  Tokens
 Class Tokens represents array of tokens. More...
class  Formula
 Class Formula encapsulates a formula for a cell. More...
class  KSPLoadingInfo
 Temporary information used only during loading. More...
class  Canvas
 The canvas builds a part of the GUI of KSpread. More...
class  HBorder
 HBorder. More...
class  VBorder
 VBorder. More...
class  ToolTip
 Tooltip, which displays the comment and cell content, when it's too short. More...
class  Cell
 For every cell in the spread sheet there is a Cell object. More...
class  Cluster
 Philipp This class defines a pointer map to all cells, which makes access to them more performant and additionally limits memory consumption. More...
class  Conditional
 Structure to indicate the condition we're testing on a cell and the special font and color that will be applied if it's true. More...
class  Conditions
 Manages a set of conditions for a cell. More...
class  Doc
 This class holds the data that makes up a spreadsheet. More...
class  FormulaEditorHighlighter
 Colours cell references in formulas. More...
class  FunctionCompletion
 Provides autocompletition facilities in formula editors. More...
class  CellEditor
 class CellEditor More...
class  ComboboxLocationEditWidget
 ComboboxLocationEditWidget. More...
class  LocationEditWidget
 A widget that allows the user to enter an arbitrary cell location to goto or cell selection to highlight. More...
class  EditWidget
 The widget that appears above the sheet and allows to edit the cells content. More...
class  InsertHandler
 This event handler is used to insert a new part. More...
class  Map
 A map is a simple container for all sheets. More...
class  EmbeddedObject
 Contains basic information for every object. More...
class  EmbeddedKOfficeObject
 Holds an embedded koffice object. More...
class  EmbeddedChart
 Holds an embedded chart object. More...
class  EmbeddedPictureObject
 Holds a picture object. More...
class  CellBinding
 This is an abstract base class only. More...
class  TextDrag
 This is a class for handling clipboard data. More...
class  Style
 The Style class represents a cell style. More...
class  CustomStyle
 Built-in or custom style defined in StyleManager dialog. More...
class  UndoAction
 Abstract base class. More...
class  Point
 Represents the position of a single cell in a workbook. More...
class  Range
 Represents a region within a workbook. More...
struct  RangeList
 range-list and cell-list TODO: move to a separate file, improve structure, add iterators and all that TODO: use this class instead of other means of range-walking all over KSpread TODO: use this as selection TODO: anything I forgot ;) More...
class  RangeIterator
 RangeIterator. More...
class  Value
 Provides a wrapper for cell value. More...
class  KPSheetSelectPage
 Print dialog page for selecting sheets to print. More...
class  View
 The View class displays a KSpread document. More...
class  KSPRSavingInfo
 Temporary information used only during saving. More...
class  Manipulator
 Manipulator. More...
class  FormatManipulator
 FormatManipulator. More...
class  ResizeColumnManipulator
 ResizeColumnManipulator. More...
class  ResizeRowManipulator
 ResizeRowManipulator. More...
class  BorderManipulator
 BorderManipulator. More...
class  BackgroundColorManipulator
 class BackgroundColorManipulator More...
class  FontColorManipulator
 class FontColorManipulator More...
class  FontManipulator
 class FontManipulator More...
class  AngleManipulator
 class AngleManipulator More...
class  HorAlignManipulator
 class HorAlignManipulator More...
class  VerAlignManipulator
 class VerAlignManipulator More...
class  MergeManipulator
 MergeManipulator. More...
class  DilationManipulator
 DilationManipulator. More...
class  AdjustColumnRowManipulator
 AdjustColumnRowManipulator. More...
class  HideShowManipulator
 HideShowManipulator. More...
class  InsertDeleteManipulator
 InsertDeleteManipulator. More...
class  ManipulatorManager
 ManipulatorManager. More...
struct  ADMStorage
 AbstractDataManipulator - provides storage of old cell data (for undo) and has an abstract method for the actual setting of new values. More...
class  DataManipulator
 DataManipulator - allows setting values on one range. More...
class  ProtectedCheck
 class ProtectedCheck can be used to check, whether a particular range is protected or not More...
class  Region
 The one for all class for points and ranges. More...
class  ValueCalc
 The ValueCalc class is used to perform all sorts of calculations. More...
class  ValueConverter
 The ValueConverter class can convert Value between various different formats. More...
class  ValueFormatter
 The ValueFormatter class generates a textual representation of data stored in a Value, with a given formatting. More...
class  ValueParser
 The ValueParser parses a text input from the user, generating Value in the desired format. More...

Namespaces

namespace  Paste
namespace  Restriction

Typedefs

typedef QValueVector< ValuevalVector
typedef Value(* FunctionPtr )(valVector, ValueCalc *, FuncExtra *)
typedef Column unsigned long int
typedef KGenericFactory
< PluginInsertCalendar > 
InsertCalendarFactory
typedef QValueList< Condition > ConditionList
typedef void(* arrayWalkFunc )(ValueCalc *, Value &result, Value val, Value param)

Enumerations

enum  BorderType {
  BorderType_Top = 0, BorderType_Bottom, BorderType_Left, BorderType_Right,
  BorderType_Vertical, BorderType_Horizontal, BorderType_FallingDiagonal, BorderType_RisingDiagonal,
  BorderType_END
}
enum  BorderShortcutType { BorderShortcutType_Remove = 0, BorderShortcutType_All, BorderShortcutType_Outline, BorderShortcutType_END }
enum  ParameterType {
  KSpread_Int, KSpread_Float, KSpread_String, KSpread_Boolean,
  KSpread_Any
}
enum  Series { Column, Row, Linear, Geometric }
enum  MoveTo {
  Bottom, Left, Top, Right,
  BottomFirst
}
enum  MethodOfCalc {
  SumOfNumber, Min, Max, Average,
  Count, NoneCalc, CountA
}
enum  FormatType {
  Generic_format = 0, Number_format = 1, Text_format = 5, Money_format = 10,
  Percentage_format = 25, Scientific_format = 30, ShortDate_format = 35, TextDate_format = 36,
  Time_format = 50, SecondeTime_format = 51, Time_format1 = 52, Time_format2 = 53,
  Time_format3 = 54, Time_format4 = 55, Time_format5 = 56, Time_format6 = 57,
  Time_format7 = 58, Time_format8 = 59, fraction_half = 70, fraction_quarter = 71,
  fraction_eighth = 72, fraction_sixteenth = 73, fraction_tenth = 74, fraction_hundredth = 75,
  fraction_one_digit = 76, fraction_two_digits = 77, fraction_three_digits = 78, date_format1 = 200,
  date_format2 = 201, date_format3 = 202, date_format4 = 203, date_format5 = 204,
  date_format6 = 205, date_format7 = 206, date_format8 = 207, date_format9 = 208,
  date_format10 = 209, date_format11 = 210, date_format12 = 211, date_format13 = 212,
  date_format14 = 213, date_format15 = 214, date_format16 = 215, date_format17 = 216,
  date_format18 = 217, date_format19 = 218, date_format20 = 219, date_format21 = 220,
  date_format22 = 221, date_format23 = 222, date_format24 = 223, date_format25 = 224,
  date_format26 = 225, Custom_format = 300, No_format = 400
}
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  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  ObjType { OBJECT_GENERAL, OBJECT_KOFFICE_PART, OBJECT_CHART, OBJECT_PICTURE }
enum  SelectionMode { SM_NONE = 0, SM_MOVERESIZE = 1, SM_ROTATE = 2, SM_PROTECT = 3 }
enum  PictureMirrorType { PM_NORMAL = 0, PM_HORIZONTAL = 1, PM_VERTICAL = 2, PM_HORIZONTALANDVERTICAL = 3 }
enum  ImageEffect {
  IE_NONE = -1, IE_CHANNEL_INTENSITY = 0, IE_FADE = 1, IE_FLATTEN = 2,
  IE_INTENSITY = 3, IE_DESATURATE = 4, IE_CONTRAST = 5, IE_NORMALIZE = 6,
  IE_EQUALIZE = 7, IE_THRESHOLD = 8, IE_SOLARIZE = 9, IE_EMBOSS = 10,
  IE_DESPECKLE = 11, IE_CHARCOAL = 12, IE_NOISE = 13, IE_BLUR = 14,
  IE_EDGE = 15, IE_IMPLODE = 16, IE_OIL_PAINT = 17, IE_SHARPEN = 18,
  IE_SPREAD = 19, IE_SHADE = 20, IE_SWIRL = 21, IE_WAVE = 22
}
enum  AlignType { AT_PAGE, AT_CELL }
enum  Comp {
  isEqual, isLess, isGreater, lessEqual,
  greaterEqual, notEqual
}
enum  Type { numeric, string }

Functions

Token::Op matchOperator (const QString &text)
bool isIdentifier (QChar ch)
QTextStream & operator<< (QTextStream &ts, Formula formula)
KAboutData * newAboutData ()
int daysPerYear (QDate const &date, int basis)
int daysBetweenDates (QDate const &date1, QDate const &date2, int basis)
static QString cellAsText (Cell *cell, unsigned int max)
bool formatIsDate (FormatType fmt)
bool formatIsTime (FormatType fmt)
bool formatIsFraction (FormatType fmt)
int util_decodeColumnLabelText (const QString &_col)
QString util_rangeColumnName (const QRect &_area)
QString util_rangeRowName (const QRect &_area)
QString util_rangeName (const QRect &_area)
QString util_rangeName (Sheet *_sheet, const QRect &_area)
QDomElement util_createElement (const QString &tagName, const QFont &font, QDomDocument &doc)
QDomElement util_createElement (const QString &tagname, const QPen &pen, QDomDocument &doc)
QFont util_toFont (QDomElement &element)
QPen util_toPen (QDomElement &element)
bool util_isAllSelected (const QRect &selection)
bool util_isColumnSelected (const QRect &selection)
bool util_isRowSelected (const QRect &selection)
bool util_isRowOrColumnSelected (const QRect &selection)
bool util_validateSheetName (const QString &name)
int util_penCompare (QPen const &pen1, QPen const &pen2)
QString convertRefToBase (const QString &sheet, const QRect &rect)
QString convertRefToRange (const QString &sheet, const QRect &rect)
void insertBracket (QString &s)
QString convertRangeToRef (const QString &sheetName, const QRect &_area)
QString convertOasisPenToString (const QPen &pen)
QPen convertOasisStringToPen (const QString &border)
bool localReferenceAnchor (const QString &_ref)
KSPREAD_EXPORT QString util_encodeColumnLabelText (int column)
 K_EXPORT_COMPONENT_FACTORY (libkspreadinsertcalendar, InsertCalendarFactory("kspreadinsertcalendar")) PluginInsertCalendar

Variables

static const char * description = I18N_NOOP("KOffice Spreadsheet Application")
static const char * version = KOFFICE_VERSION_STRING

Function Documentation

bool KSpread::isIdentifier ( QChar  ch  ) 

helper function: return true for valid identifier character

Definition at line 356 of file formula.cc.

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 130 of file formula.cc.

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

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

Definition at line 1531 of file formula.cc.

KSPREAD_EXPORT int KSpread::util_decodeColumnLabelText ( const QString &  _col  ) 

Call this function to decode the text of a column label to an integer i.e.

AA->27

Definition at line 57 of file kspread_util.cc.

KSPREAD_EXPORT QString KSpread::util_encodeColumnLabelText ( int  column  ) 

Call this function to encode an integer to the text of the column label i.e.

27->AA

KDE Home | KDE Accessibility Home | Description of Access Keys