kspread

KSpread Namespace Reference

Namespaces

namespace  Paste
 
namespace  Restriction
 

Classes

class  AdjustColumnRowManipulator
 
struct  ADMStorage
 
class  AngleManipulator
 
class  BackgroundColorManipulator
 
class  BorderManipulator
 
class  Canvas
 
class  Cell
 
class  CellBinding
 
class  CellEditor
 
class  CellFormatDialog
 
class  CellFormatPageFloat
 
class  Cluster
 
class  ComboboxLocationEditWidget
 
class  Conditional
 
class  Conditions
 
class  CSVDialog
 
class  CustomStyle
 
class  DataManipulator
 
class  DependencyManager
 
class  DilationManipulator
 
class  DissociateCellCommand
 
class  Doc
 
class  EditWidget
 
class  EmbeddedChart
 
class  EmbeddedKOfficeObject
 
class  EmbeddedObject
 
class  EmbeddedPictureObject
 
class  FontColorManipulator
 
class  FontManipulator
 
class  FormatDialog
 
class  FormatManipulator
 
class  Formula
 
class  FormulaEditorHighlighter
 
class  FunctionCompletion
 
class  HBorder
 
class  HideShowManipulator
 
class  HorAlignManipulator
 
class  InsertDeleteManipulator
 
class  InsertHandler
 
class  KPSheetSelectPage
 
class  KSPLoadingInfo
 
class  KSPRSavingInfo
 
class  LocationEditWidget
 
class  Manipulator
 
class  ManipulatorManager
 
class  Map
 
class  MergeCellCommand
 
class  MergeManipulator
 
class  Point
 
class  ProtectedCheck
 
class  Range
 
struct  RangeDependency
 
class  RangeIterator
 
struct  RangeList
 
class  Region
 
class  RenameSheetCommand
 
class  ResizeColumnManipulator
 
class  ResizeRowManipulator
 
class  SheetPropertiesCommand
 
class  Style
 
class  TextDrag
 
class  Token
 
class  Tokens
 
class  ToolTip
 
class  UndoAction
 
class  UndoWrapperCommand
 
class  Value
 
class  ValueCalc
 
class  ValueConverter
 
class  ValueFormatter
 
class  ValueParser
 
class  VBorder
 
class  VerAlignManipulator
 
class  View
 

Typedefs

typedef TQValueVector< Value > valVector
 
typedef Value(* FunctionPtr) (valVector, ValueCalc *, FuncExtra *)
 
typedef Column unsigned long int
 
typedef KGenericFactory< PluginInsertCalendar > InsertCalendarFactory
 
typedef TQValueList< 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

TQTextStream & operator<< (TQTextStream &ts, Formula formula)
 
Token::Op matchOperator (const TQString &text)
 
bool isIdentifier (TQChar ch)
 
TDEAboutData * newAboutData ()
 
int daysPerYear (TQDate const &date, int basis)
 
int daysBetweenDates (TQDate const &date1, TQDate const &date2, int basis)
 
static TQString cellAsText (Cell *cell, unsigned int max)
 
bool formatIsDate (FormatType fmt)
 
bool formatIsTime (FormatType fmt)
 
bool formatIsFraction (FormatType fmt)
 
KSPREAD_EXPORT TQString util_rangeName (const TQRect &_area)
 
KSPREAD_EXPORT TQString util_rangeName (Sheet *_sheet, const TQRect &_area)
 
TQString util_rangeColumnName (const TQRect &_area)
 
TQString util_rangeRowName (const TQRect &_area)
 
KSPREAD_EXPORT int util_decodeColumnLabelText (const TQString &_col)
 
KSPREAD_EXPORT TQString util_encodeColumnLabelText (int column)
 
bool util_isAllSelected (const TQRect &selection)
 
bool util_isColumnSelected (const TQRect &selection)
 
bool util_isRowSelected (const TQRect &selection)
 
bool util_isRowOrColumnSelected (const TQRect &selection)
 
bool util_validateSheetName (const TQString &name)
 
TQDomElement util_createElement (const TQString &tagName, const TQFont &font, TQDomDocument &doc)
 
TQDomElement util_createElement (const TQString &tagname, const TQPen &pen, TQDomDocument &doc)
 
TQFont util_toFont (TQDomElement &element)
 
TQPen util_toPen (TQDomElement &element)
 
int util_penCompare (TQPen const &pen1, TQPen const &pen2)
 
TQString convertRefToRange (const TQString &sheet, const TQRect &rect)
 
TQString convertRefToBase (const TQString &sheet, const TQRect &rect)
 
TQString convertRangeToRef (const TQString &sheetName, const TQRect &_area)
 
void insertBracket (TQString &s)
 
TQString convertOasisPenToString (const TQPen &pen)
 
TQPen convertOasisStringToPen (const TQString &str)
 
KSPREAD_EXPORT bool localReferenceAnchor (const TQString &_ref)
 

Variables

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

Detailed Description

The KSpread namespace.

Typedef Documentation

◆ arrayWalkFunc

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

Definition at line 51 of file valuecalc.h.

◆ ConditionList

typedef TQValueList<Condition> KSpread::ConditionList

Definition at line 49 of file valuecalc.h.

◆ FunctionPtr

typedef Value(* KSpread::FunctionPtr) (valVector, ValueCalc *, FuncExtra *)

Definition at line 48 of file functions.h.

◆ InsertCalendarFactory

typedef KGenericFactory<PluginInsertCalendar> KSpread::InsertCalendarFactory

Definition at line 49 of file kspread_plugininsertcalendar.cpp.

◆ int

typedef Row unsigned long KSpread::int

Definition at line 14 of file kspread_types.h.

◆ valVector

typedef TQValueVector<Value> KSpread::valVector

Definition at line 36 of file functions.h.

Enumeration Type Documentation

◆ AlignType

enum KSpread::AlignType

Definition at line 100 of file kspread_object.h.

◆ BorderShortcutType

enum KSpread::BorderShortcutType

Definition at line 89 of file kspread_dlg_layout.h.

◆ BorderType

enum KSpread::BorderType

Definition at line 76 of file kspread_dlg_layout.h.

◆ Comp

enum KSpread::Comp

Definition at line 37 of file valuecalc.h.

◆ FormatType

enum KSpread::FormatType

Definition at line 131 of file kspread_global.h.

◆ ImageEffect

enum KSpread::ImageEffect

Definition at line 73 of file kspread_object.h.

◆ MethodOfCalc

enum KSpread::MethodOfCalc

Definition at line 129 of file kspread_global.h.

◆ ModifyType

enum KSpread::ModifyType

Definition at line 152 of file kspread_global.h.

◆ MoveTo

enum KSpread::MoveTo

Definition at line 128 of file kspread_global.h.

◆ ObjType

enum KSpread::ObjType

Definition at line 52 of file kspread_object.h.

◆ ParameterType

enum KSpread::ParameterType

Definition at line 79 of file functions.h.

◆ PictureMirrorType

enum KSpread::PictureMirrorType

Definition at line 66 of file kspread_object.h.

◆ PropValue

enum KSpread::PropValue

Definition at line 165 of file kspread_global.h.

◆ SelectionMode

enum KSpread::SelectionMode

Definition at line 59 of file kspread_object.h.

◆ Series

enum KSpread::Series

Definition at line 126 of file kspread_global.h.

◆ ToolEditMode

enum KSpread::ToolEditMode

Definition at line 172 of file kspread_global.h.

◆ Type

enum KSpread::Type

Definition at line 38 of file valuecalc.h.

Function Documentation

◆ cellAsText()

static TQString KSpread::cellAsText ( Cell *  cell,
unsigned int  max 
)
static

Definition at line 4981 of file kspread_sheet.cpp.

◆ convertOasisPenToString()

TQString KSpread::convertOasisPenToString ( const TQPen &  pen)

Definition at line 926 of file kspread_util.cpp.

◆ convertOasisStringToPen()

TQPen KSpread::convertOasisStringToPen ( const TQString &  str)

Definition at line 967 of file kspread_util.cpp.

◆ convertRangeToRef()

TQString KSpread::convertRangeToRef ( const TQString &  sheetName,
const TQRect &  _area 
)

Definition at line 921 of file kspread_util.cpp.

◆ convertRefToBase()

TQString KSpread::convertRefToBase ( const TQString &  sheet,
const TQRect &  rect 
)

Definition at line 862 of file kspread_util.cpp.

◆ convertRefToRange()

TQString KSpread::convertRefToRange ( const TQString &  sheet,
const TQRect &  rect 
)

Definition at line 876 of file kspread_util.cpp.

◆ daysBetweenDates()

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

Definition at line 89 of file kspread_functions_helper.cpp.

◆ daysPerYear()

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

Definition at line 66 of file kspread_functions_helper.cpp.

◆ formatIsDate()

bool KSpread::formatIsDate ( FormatType  fmt)

Definition at line 38 of file kspread_util.cpp.

◆ formatIsFraction()

bool KSpread::formatIsFraction ( FormatType  fmt)

Definition at line 49 of file kspread_util.cpp.

◆ formatIsTime()

bool KSpread::formatIsTime ( FormatType  fmt)

Definition at line 44 of file kspread_util.cpp.

◆ insertBracket()

void KSpread::insertBracket ( TQString &  s)

Definition at line 899 of file kspread_util.cpp.

◆ isIdentifier()

bool KSpread::isIdentifier ( TQChar  ch)

helper function: return true for valid identifier character

Definition at line 356 of file formula.cpp.

◆ localReferenceAnchor()

bool KSpread::localReferenceAnchor ( const TQString &  _ref)

Definition at line 1008 of file kspread_util.cpp.

◆ matchOperator()

Token::Op KSpread::matchOperator ( const TQString &  text)

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

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

Definition at line 130 of file formula.cpp.

◆ newAboutData()

TDEAboutData * KSpread::newAboutData ( )

Definition at line 35 of file kspread_aboutdata.h.

◆ operator<<()

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

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

◆ util_createElement() [1/2]

TQDomElement KSpread::util_createElement ( const TQString &  tagName,
const TQFont &  font,
TQDomDocument &  doc 
)

Definition at line 102 of file kspread_util.cpp.

◆ util_createElement() [2/2]

TQDomElement KSpread::util_createElement ( const TQString &  tagname,
const TQPen &  pen,
TQDomDocument &  doc 
)

Definition at line 122 of file kspread_util.cpp.

◆ util_decodeColumnLabelText()

int KSpread::util_decodeColumnLabelText ( const TQString &  _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.cpp.

◆ util_encodeColumnLabelText()

KSPREAD_EXPORT TQString KSpread::util_encodeColumnLabelText ( int  column)

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

27->AA

◆ util_isAllSelected()

bool KSpread::util_isAllSelected ( const TQRect &  selection)

Definition at line 737 of file kspread_util.cpp.

◆ util_isColumnSelected()

bool KSpread::util_isColumnSelected ( const TQRect &  selection)

Definition at line 743 of file kspread_util.cpp.

◆ util_isRowOrColumnSelected()

bool KSpread::util_isRowOrColumnSelected ( const TQRect &  selection)

Definition at line 753 of file kspread_util.cpp.

◆ util_isRowSelected()

bool KSpread::util_isRowSelected ( const TQRect &  selection)

Definition at line 748 of file kspread_util.cpp.

◆ util_penCompare()

int KSpread::util_penCompare ( TQPen const &  pen1,
TQPen const &  pen2 
)

Definition at line 829 of file kspread_util.cpp.

◆ util_rangeColumnName()

TQString KSpread::util_rangeColumnName ( const TQRect &  _area)

Definition at line 76 of file kspread_util.cpp.

◆ util_rangeName() [1/2]

TQString KSpread::util_rangeName ( const TQRect &  _area)

Definition at line 91 of file kspread_util.cpp.

◆ util_rangeName() [2/2]

TQString KSpread::util_rangeName ( Sheet *  _sheet,
const TQRect &  _area 
)

Definition at line 97 of file kspread_util.cpp.

◆ util_rangeRowName()

TQString KSpread::util_rangeRowName ( const TQRect &  _area)

Definition at line 84 of file kspread_util.cpp.

◆ util_toFont()

TQFont KSpread::util_toFont ( TQDomElement &  element)

Definition at line 131 of file kspread_util.cpp.

◆ util_toPen()

TQPen KSpread::util_toPen ( TQDomElement &  element)

Definition at line 169 of file kspread_util.cpp.

◆ util_validateSheetName()

bool KSpread::util_validateSheetName ( const TQString &  name)

Definition at line 760 of file kspread_util.cpp.

Variable Documentation

◆ description

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

Definition at line 30 of file kspread_aboutdata.h.

◆ version

const char* KSpread::version =KOFFICE_VERSION_STRING
static

Definition at line 33 of file kspread_aboutdata.h.