LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Included Services | Exported Interfaces | List of all members
SheetCellCursor Service Referencepublished

represents a cursor in a spreadsheet. More...

import "SheetCellCursor.idl";

Inheritance diagram for SheetCellCursor:
CellCursor SheetCellRange XSheetCellCursor XUsedAreaCursor XInterface XSheetCellRange XModifyBroadcaster XTolerantMultiPropertySet XChartDataArray XUniqueCellFormatRangesSupplier XCellFormatRangesSupplier XSheetFilterableEx XSubTotalCalculatable XImportable XSortable XMultipleOperation XArrayFormulaRange XCellSeries XSheetOperation XCellRangeAddressable XCellRangeFormula XCellRangeData XSheetCellRange XAutoFormattable XColumnRowRange XIndent XMergeable XReplaceable SheetRangesQuery ParagraphProperties CharacterPropertiesComplex CharacterPropertiesAsian CharacterProperties CellRange XCellCursor

Included Services

service com::sun::star::table::CellCursor
 provides common methods to control the position of the cursor. More...
 
service com::sun::star::sheet::SheetCellRange
 provides the complete functionality of a cell range in a spreadsheet document. More...
 
- Included Services inherited from SheetCellRange
service com::sun::star::table::CellRange
 provides basic handling of cell ranges and contributes common cell formatting properties. More...
 
service com::sun::star::style::CharacterProperties
 contributes properties for character formatting of Western text. More...
 
service com::sun::star::style::CharacterPropertiesAsian
 contributes properties for character formatting of Asian text. More...
 
service com::sun::star::style::CharacterPropertiesComplex
 contributes properties for character formatting of Complex text. More...
 
service com::sun::star::style::ParagraphProperties
 contributes properties for paragraph formatting. More...
 
service com::sun::star::sheet::SheetRangesQuery
 provides interfaces to find cells with specific properties. More...
 
- Included Services inherited from CellRange
service com::sun::star::table::CellProperties
 contains the properties of the cells of this cell range. More...
 

Exported Interfaces

interface com::sun::star::sheet::XSheetCellCursor
 provides advanced methods to control the position of the cursor. More...
 
interface com::sun::star::sheet::XUsedAreaCursor
 provides methods to find the used area of the entire sheet. More...
 
- Exported Interfaces inherited from CellCursor
interface com::sun::star::table::XCellCursor
 provides methods to control the position of the cursor. More...
 
- Exported Interfaces inherited from SheetCellRange
interface com::sun::star::util::XReplaceable
 provides "Find & Replace" functionality. More...
 
interface com::sun::star::util::XMergeable
 provides merging and unmerging the cells of this cell range. More...
 
interface com::sun::star::util::XIndent
 provides modifying the cell indentation. More...
 
interface com::sun::star::table::XColumnRowRange
 provides access to the collections of columns and rows. More...
 
interface com::sun::star::table::XAutoFormattable
 provides applying an AutoFormat to the cell range. More...
 
interface com::sun::star::sheet::XSheetCellRange
 provides access to the spreadsheet that contains this cell range. More...
 
interface com::sun::star::sheet::XCellRangeData
 provides simultaneous access to the contents of all cells. More...
 
interface com::sun::star::sheet::XCellRangeFormula
 provides simultaneous access to the formula contents of all cells. More...
 
interface com::sun::star::sheet::XCellRangeAddressable
 provides access to the cell range address of this range. More...
 
interface com::sun::star::sheet::XSheetOperation
 provides computation of a value based on the contents of all cells of this range and to clear specific cells. More...
 
interface com::sun::star::sheet::XCellSeries
 provides filling out the cell range automatically with values based on a start value, step count and fill mode. More...
 
interface com::sun::star::sheet::XArrayFormulaRange
 provides handling of array formulas. More...
 
interface com::sun::star::sheet::XMultipleOperation
 provides access to the Multiple Operations feature. More...
 
interface com::sun::star::util::XSortable
 provides sorting functionality. More...
 
interface com::sun::star::util::XImportable
 provides functionality to import data from external data sources. More...
 
interface com::sun::star::sheet::XSubTotalCalculatable
 provides calculating SubTotal values in this range. More...
 
interface com::sun::star::sheet::XSheetFilterableEx
 provides filtering the contents of this range. More...
 
interface com::sun::star::sheet::XCellFormatRangesSupplier
 provide access to a collection of equal-formatted cell ranges. More...
 
interface com::sun::star::sheet::XUniqueCellFormatRangesSupplier
 provide access to a collection of equal-formatted cell ranges. More...
 
interface com::sun::star::chart::XChartDataArray
 provides modifying the source data cells of a chart and makes it possible to learn about changes in the cell values. More...
 
interface com::sun::star::beans::XTolerantMultiPropertySet
 
interface com::sun::star::util::XModifyBroadcaster
 
- Exported Interfaces inherited from CellRange
interface com::sun::star::table::XCellRange
 provides access to the cells or to sub-ranges of this cell range. More...
 
- Exported Interfaces inherited from CellProperties
interface com::sun::star::beans::XPropertySet
 published service PropertySet More...
 
- Exported Interfaces inherited from SheetRangesQuery
interface com::sun::star::sheet::XCellRangesQuery
 provides methods to query for cell ranges with specific contents. More...
 
interface com::sun::star::sheet::XFormulaQuery
 provides methods to find dependent cells of formula cells. More...
 

Additional Inherited Members

- Public Member Functions inherited from XCellCursor
void gotoStart ()
 points the cursor to a single cell which is the beginning of a contiguous series of (filled) cells. More...
 
void gotoEnd ()
 points the cursor to a single cell which is the end of a contiguous series of (filled) cells. More...
 
void gotoNext ()
 points the cursor to the next unprotected cell. More...
 
void gotoPrevious ()
 points the cursor to the previous unprotected cell. More...
 
void gotoOffset ([in] long nColumnOffset,[in] long nRowOffset)
 moves the origin of the cursor relative to the current position. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName,[in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XCellRange
com::sun::star::table::XCell getCellByPosition ([in] long nColumn,[in] long nRow) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a single cell within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByPosition ([in] long nLeft,[in] long nTop,[in] long nRight,[in] long nBottom) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a sub-range of cells within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByName ([in] string aRange)
 Returns a sub-range of cells within the range. More...
 
- Public Member Functions inherited from XCellRangesQuery
com::sun::star::sheet::XSheetCellRanges queryVisibleCells ()
 queries all visible cells. More...
 
com::sun::star::sheet::XSheetCellRanges queryEmptyCells ()
 queries all empty cells. More...
 
com::sun::star::sheet::XSheetCellRanges queryContentCells ([in] short nContentFlags)
 queries all cells with the specified content type(s). More...
 
com::sun::star::sheet::XSheetCellRanges queryFormulaCells ([in] long nResultFlags)
 queries all formula cells with the specified result type. More...
 
com::sun::star::sheet::XSheetCellRanges queryColumnDifferences ([in] com::sun::star::table::CellAddress aCompare)
 queries all cells with different values in a specified row. More...
 
com::sun::star::sheet::XSheetCellRanges queryRowDifferences ([in] com::sun::star::table::CellAddress aCompare)
 queries all cells with different values in a specified column. More...
 
com::sun::star::sheet::XSheetCellRanges queryIntersection ([in] com::sun::star::table::CellRangeAddress aRange)
 intersects the current cell range(s) with the specified cell range. More...
 
- Public Member Functions inherited from XFormulaQuery
com::sun::star::sheet::XSheetCellRanges queryDependents ([in] boolean bRecursive)
 queries all dependent formula cells. More...
 
com::sun::star::sheet::XSheetCellRanges queryPrecedents ([in] boolean bRecursive)
 queries all precedent cells. More...
 
- Public Member Functions inherited from XReplaceable
com::sun::star::util::XReplaceDescriptor createReplaceDescriptor ()
 creates a descriptor which contains properties that specify a search in this container. More...
 
long replaceAll ([in] com::sun::star::util::XSearchDescriptor xDesc)
 searches for all occurrences of whatever is specified. More...
 
- Public Member Functions inherited from XMergeable
void merge ([in] boolean bMerge)
 merges/unmerges the area specified by this object. More...
 
boolean getIsMerged ()
 
- Public Member Functions inherited from XIndent
void decrementIndent ()
 shifts the indentation by one default step to the left. More...
 
void incrementIndent ()
 shifts the indentation by one default step to the right. More...
 
- Public Member Functions inherited from XColumnRowRange
com::sun::star::table::XTableColumns getColumns ()
 returns the collection of columns in the range. More...
 
com::sun::star::table::XTableRows getRows ()
 returns the collection of rows in the range. More...
 
- Public Member Functions inherited from XAutoFormattable
void autoFormat ([in] string aName) raises ( com::sun::star::lang::IllegalArgumentException )
 applies an AutoFormat to the cell range of the current context. More...
 
- Public Member Functions inherited from XSheetCellRange
com::sun::star::sheet::XSpreadsheet getSpreadsheet ()
 returns the spreadsheet interface which contains the cell range. More...
 
- Public Member Functions inherited from XCellRangeData
sequence< sequence< any > > getDataArray ()
 gets an array from the contents of the cell range. More...
 
void setDataArray ([in] sequence< sequence< any > > aArray)
 fills the cell range with values from an array. More...
 
- Public Member Functions inherited from XCellRangeAddressable
com::sun::star::table::CellRangeAddress getRangeAddress ()
 returns the address of the cell range in the spreadsheet document. More...
 
- Public Member Functions inherited from XSheetOperation
double computeFunction ([in] com::sun::star::sheet::GeneralFunction nFunction) raises ( com::sun::star::uno::Exception )
 computes a general function based on all cells in the current cell range(s). More...
 
void clearContents ([in] long nContentFlags)
 unnecessary More...
 
- Public Member Functions inherited from XCellSeries
void fillSeries ([in] com::sun::star::sheet::FillDirection nFillDirection,[in] com::sun::star::sheet::FillMode nFillMode,[in] com::sun::star::sheet::FillDateMode nFillDateMode,[in] double fStep,[in] double fEndValue)
 fills all cells in the range based on the specified settings. More...
 
void fillAuto ([in] com::sun::star::sheet::FillDirection nFillDirection,[in] long nSourceCount)
 fills all cells in the range in a way that is specified by the first cell(s) in the range. More...
 
- Public Member Functions inherited from XArrayFormulaRange
string getArrayFormula ()
 returns the array formula of the range or an empty string, if the range does not contain an array formula. More...
 
void setArrayFormula ([in] string aFormula)
 applies the array formula to the entire cell range. More...
 
- Public Member Functions inherited from XMultipleOperation
void setTableOperation ([in] com::sun::star::table::CellRangeAddress aFormulaRange,[in] com::sun::star::sheet::TableOperationMode nMode,[in] com::sun::star::table::CellAddress aColumnCell,[in] com::sun::star::table::CellAddress aRowCell)
 creates a table of formulas (a "Multiple Operations Table"). More...
 
- Public Member Functions inherited from XSortable
sequence
< com::sun::star::beans::PropertyValue
createSortDescriptor ()
 
void sort ([in] sequence< com::sun::star::beans::PropertyValue > xDescriptor)
 sorts the contents of the object according to the specified properties. More...
 
- Public Member Functions inherited from XImportable
sequence
< com::sun::star::beans::PropertyValue
createImportDescriptor ([in] boolean bEmpty)
 
void doImport ([in] sequence< com::sun::star::beans::PropertyValue > aDescriptor)
 imports data from an external database. More...
 
- Public Member Functions inherited from XSubTotalCalculatable
com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor ([in] boolean bEmpty)
 creates a subtotal descriptor. More...
 
void applySubTotals ([in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor,[in] boolean bReplace)
 creates subtotals using the settings of the passed descriptor. More...
 
void removeSubTotals ()
 removes the subtotals from the current object. More...
 
- Public Member Functions inherited from XSheetFilterableEx
com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptorByObject ([in] com::sun::star::sheet::XSheetFilterable xObject)
 creates a filter descriptor for the specified filterable object from the contents of this object. More...
 
- Public Member Functions inherited from XCellFormatRangesSupplier
com::sun::star::container::XIndexAccess getCellFormatRanges ()
 returns a collection of equal-formatted cell ranges. More...
 
- Public Member Functions inherited from XUniqueCellFormatRangesSupplier
com::sun::star::container::XIndexAccess getUniqueCellFormatRanges ()
 returns a collection of equal-formatted cell range collections. More...
 
- Public Member Functions inherited from XChartDataArray
sequence< sequence< double > > getData ()
 retrieves the numerical data as a nested sequence of values. More...
 
void setData ([in] sequence< sequence< double > > aData)
 sets the chart data as an array of numbers. More...
 
sequence< string > getRowDescriptions ()
 retrieves the description texts for all rows. More...
 
void setRowDescriptions ([in] sequence< string > aRowDescriptions)
 sets the description texts for all rows. More...
 
sequence< string > getColumnDescriptions ()
 retrieves the description texts for all columns. More...
 
void setColumnDescriptions ([in] sequence< string > aColumnDescriptions)
 sets the description texts for all columns. More...
 
- Public Member Functions inherited from XSheetCellCursor
void collapseToCurrentRegion ()
 expands the cursor into the region containing the cells to which it currently points. More...
 
void collapseToCurrentArray ()
 collapses the cursor into the range of the array formula to which it is currently pointing. More...
 
void collapseToMergedArea ()
 expands the cursor to merged cell ranges. More...
 
void expandToEntireColumns ()
 expands the cursor to include the entire columns of the cells to which it is currently pointing. More...
 
void expandToEntireRows ()
 expands the cursor to include the entire rows of the cells to which it is currently pointing. More...
 
void collapseToSize ([in] long nColumns,[in] long nRows)
 changes the size of a cursor range. More...
 
- Public Member Functions inherited from XUsedAreaCursor
void gotoStartOfUsedArea ([in] boolean bExpand)
 points the cursor to the start of the used area. More...
 
void gotoEndOfUsedArea ([in] boolean bExpand)
 points the cursor to the end of the used area. More...
 
- Public Attributes inherited from SheetCellRange
com::sun::star::awt::Point Position
 contains the position of the top left cell of this range in the sheet (in 1/100 mm). More...
 
com::sun::star::awt::Size Size
 contains the size of this range (in 1/100 mm). More...
 
com::sun::star::sheet::XSheetConditionalEntries ConditionalFormat
 contains the conditional formatting settings for this cell. More...
 
com::sun::star::sheet::XSheetConditionalEntries ConditionalFormatLocal
 contains the conditional formatting settings for this cell, using localized formulas. More...
 
com::sun::star::beans::XPropertySet Validation
 contains the data validation settings for this cell. More...
 
com::sun::star::beans::XPropertySet ValidationLocal
 contains the data validation settings for this cell, using localized formulas. More...
 
string AbsoluteName
 Returns the absolute address of the range as string, e.g. More...
 
- Protected Member Functions inherited from XCellRangeFormula
sequence< sequence< string > > getFormulaArray ()
 gets an array from the contents of the cell range. More...
 
void setFormulaArray ([in] sequence< sequence< string > > aArray)
 fills the cell range with values from an array. More...
 
- Protected Member Functions inherited from XTolerantMultiPropertySet
sequence
< com::sun::star::beans::SetPropertyTolerantFailed
setPropertyValuesTolerant ([in] sequence< string > aPropertyNames,[in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException )
 sets the values to the properties with the specified names. More...
 
sequence
< com::sun::star::beans::GetPropertyTolerantResult
getPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve the values of the specified properties More...
 
sequence
< com::sun::star::beans::GetDirectPropertyTolerantResult
getDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve only those values of the specified properties which are direct values. More...
 
- Protected Member Functions inherited from XModifyBroadcaster
void addModifyListener ([in] com::sun::star::util::XModifyListener aListener)
 adds the specified listener to receive events "modified." More...
 
void removeModifyListener ([in] com::sun::star::util::XModifyListener aListener)
 removes the specified listener. More...
 

Detailed Description

represents a cursor in a spreadsheet.

A cursor is a cell range which provides additional methods to move through the table (i.e. to find specific cell ranges).

Exported Interfaces

provides the complete functionality of a cell range in a spreadsheet document.

provides common methods to control the position of the cursor.

Exported Interfaces

provides advanced methods to control the position of the cursor.

provides methods to find the used area of the entire sheet.


The documentation for this service was generated from the following file: