com::sun::star::util Module Reference

Miscellaneous interfaces for sorting, connecting objects etc. More...

Constant Groups
constants	Endianness
	These constants describe the endianness of data structures.
constants	MeasureUnit
	These constants are used to specify a measure.
constants	NumberFormat
	contains constants that are used to specify the type of a number format.
constants	SearchAlgorithms2
	Constants that define the search algorithm to be used with com::sun::star::util::SearchOptions2::SearchAlgorithms2.
constants	SearchFlags
	Flags for search methods.

Classes
struct	AliasProgrammaticPair
	represents an entry from a component which implements the XLocalizedAliases. More...
struct	AtomClassRequest
	is used to describe which atoms the user wants to know about. More...
struct	AtomDescription
	contains a string and the corresponding registered atom . More...
service	BootstrapMacroExpander
	Macro expander expanding using rtl bootstrap notation. More...
struct	CellProtection
	describes the kind of protection for a protectable cell. More...
struct	ChangesEvent
	This event is fired when a set of changes becomes effective on the source of the event. More...
exception	CloseVetoException
	this exception can be thrown to prevent the environment of any object from closing More...
struct	DataEditorEvent
	specifies an event broadcasted by an XDataEditor. More...
struct	Date
	represents a date value. More...
struct	DateTime
	represents a combined date+time value. More...
struct	DateTimeRange
	represents a range of date+time values. More...
struct	DateTimeWithTimezone
	represents a combined date+time value with time zone. More...
struct	DateWithTimezone
	represents a date value with time zone. More...
struct	Duration
	represents a duration. More...
struct	ElementChange
	This structure describes a single change that is part of a batch of changes. More...
exception	InvalidStateException
	is thrown when an object's state does not allow to call requested functionality. More...
service	JobManager
	Manage cancelable jobs. More...
service	MacroExpander
	This meta service supports the XMacroExpander interface for expanding arbitrary macro expressions, i.e. More...
exception	MalformedNumberFormatException
	is thrown when a NumberFormat string is syntactically incorrect. More...
struct	ModeChangeEvent
	allows to veto changes in an object's internal mode. More...
exception	NotLockedException
	is raised when attempt is made to unlock a lockable component which actually is not locked. More...
exception	NotNumericException
	indicates that a non-numeric string is to be converted to a number. More...
service	NumberFormatProperties
	contains properties specifying the behavior of a NumberFormatter. More...
service	NumberFormats
	specifies a container of number formats. More...
service	NumberFormatSettings
	specifies the settings for number formatting. More...
service	NumberFormatsSupplier
	provides an supplier of number formats More...
service	NumberFormatter
	represents an object which can format numbers and strings. More...
service	OfficeInstallationDirectories
	encapsulates access to the current office installation directory and office user data directory, provides functionality to create URLs containing relocatable (not absolute) references to the current office installation directory and user data directory and vice versa. More...
service	PathSettings
	A legacy (single-instance) service-variant of thePathSettings singleton. More...
service	PathSubstitution
	A service to support the substitution and resubstitution of path variables. More...
service	ReplaceDescriptor
	describes what and how to replace strings. More...
struct	RevisionTag
	represents the information that describes a revision of something. More...
service	SearchDescriptor
	describes what and how to search within a container. More...
struct	SearchOptions
struct	SearchOptions2
	This augments com::sun::star::util::SearchOptions to be able to specify additional search algorithms for use with com::sun::star::util::XTextSearch2. More...
struct	SearchResult
service	Sortable
	provides an interface for sorting. More...
service	SortDescriptor
	specifies the properties which can be used to describe a sort order applied to an XSortable. More...
service	SortDescriptor2
	gives access to the properties of a sort descriptor. More...
struct	SortField
	describes a single field in a sort descriptor. More...
service	TextSearch
	search a string with a defined algorithm in another string. More...
service	TextSearch2
	search a string with a defined algorithm in another string. More...
singleton	theMacroExpander
	A service that has to deal with macrofied strings will preprocess those strings using the macro expander singleton. More...
singleton	theOfficeInstallationDirectories
	encapsulates access to the current office installation directory and office user data directory, provides functionality to create URLs containing relocatable (not absolute) references to the current office installation directory and user data directory and vice versa. More...
singleton	thePathSettings
	Supports read/write access and listener for the paths properties that the Office uses. More...
struct	Time
	represents a time value. More...
struct	TimeWithTimezone
	represents a combined time value with time zone. More...
service	UriAbbreviation
	Abbreviate arbitrary URIs. More...
struct	URL
	represents the structure of a Uniform Resource Locator. More...
service	URLTransformer
	helps to split up a string containing a URL into its structural parts and assembles the parts into a single string. More...
exception	VetoException
	thrown to indicate a general veto. More...
interface	XAccounting
	allows estimating the memory usage of a service. More...
interface	XAtomServer
	an interface to map between strings and ids More...
interface	XBinaryDataContainer
	Container for binary data, typically an in-memory content of files. More...
interface	XBroadcaster
	allows to control notification behavior of a broadcaster. More...
interface	XCacheInfo
	Interface that allows an implementation to opt out from caching. More...
interface	XCancellable
	offers the possibility of canceling a job. More...
interface	XChainable
	enables the object to be a member of a chain. More...
interface	XChangesBatch
	this interface enables applying a set of changes in one batch transaction. More...
interface	XChangesListener
	receives events from batch change broadcaster objects. More...
interface	XChangesNotifier
	broadcasts events about multiple changes that occur in bulk. More...
interface	XChangesSet
	this interface enables inspecting a set of changes forming one batch transaction. More...
interface	XCloneable
	makes it possible to create a copy of the object which supports this interface. More...
interface	XCloseable
	makes it possible to release any objects in an ordered manner by using a two-step mechanism More...
interface	XCloseBroadcaster
	broadcasts each tried closing of an object to all interest listener More...
interface	XCloseListener
	makes it possible to receive events when an object is called for closing More...
interface	XComplexColor
	Complex color interface. More...
interface	XDataEditor
	connects to a model and broadcasts status change events. More...
interface	XDataEditorListener
	makes it possible to receive status change events from an XDataEditor. More...
interface	XFlushable
	is supported by objects with data that can be flushed to a data source. More...
interface	XFlushListener
	makes it possible to receive flushed events. More...
interface	XImportable
	makes it possible to import files into the object. More...
interface	XIndent
	allows indentation of the object to be changed. More...
interface	XJobManager
	Manage cancelable jobs. More...
interface	XLinkUpdate
	allows initiating an update of linked parts of a document. More...
interface	XLocalizedAliases
	is the interface for binding programmatic names to aliases. More...
interface	XLockable
	allows locking a component More...
interface	XMacroExpander
	Expands macro in expressions, i.e. More...
interface	XMergeable
	represents a range of cells that can be merged. More...
interface	XModeChangeApproveListener
	allows to veto changes in an object's internal mode. More...
interface	XModeChangeBroadcaster
	broadcasts changes in an object's internal mode. More...
interface	XModeChangeListener
	allows to listen for changes in an object's internal mode. More...
interface	XModeSelector
	is supported by objects which supply different modes. More...
interface	XModifiable
	makes the modify state of the object accessible. More...
interface	XModifiable2
	allows to control modifiable state change. More...
interface	XModifyBroadcaster
	broadcasts each modification made on the date data of the object which supports this interface. More...
interface	XModifyListener
	makes it possible to receive events when a model object changes. More...
interface	XNumberFormatPreviewer
	represents a number formatter which can preview number formats without inserting them. More...
interface	XNumberFormats
	provides access to multiple NumberFormats. More...
interface	XNumberFormatsSupplier
	supplies the collection of NumberFormats (for example, in a document) and the settings belonging to these formats. More...
interface	XNumberFormatter
	represents a number formatter. More...
interface	XNumberFormatter2
	Provides a unified interface for the NumberFormatter service to implement. More...
interface	XNumberFormatTypes
	represents functions to get specific, predefined number formats. More...
interface	XOfficeInstallationDirectories
	encapsulates access to the current office installation directory and office user data directory, provides functionality to create URLs containing relocatable (not absolute) references to the current office installation directory and user data directory and vice versa. More...
interface	XPathSettings
interface	XPropertyReplace
	makes it possible to search and replace properties. More...
interface	XProtectable
	makes it possible to protect objects from modifications. More...
interface	XRefreshable
	is supported by objects with data that can be refreshed from a data source. More...
interface	XRefreshListener
	makes it possible to receive refreshed events. More...
interface	XReplaceable
	makes it possible to replace strings in a text described by a SearchDescriptor. More...
interface	XReplaceDescriptor
	specifies a string replace operation. More...
interface	XSearchable
	enables the object to look for specified contents of the object (in particular, for a text range which contains a specific string pattern). More...
interface	XSearchDescriptor
	specifies a string search operation. More...
interface	XSortable
	makes it possible to sort the contents of this object. More...
interface	XStringAbbreviation
	Abbreviate arbitrary strings. More...
interface	XStringEscape
	This interface is used to encode an arbitrary String into a escaped form. More...
interface	XStringMapping
	provides a mapping from string to string More...
interface	XStringSubstitution
	A common interface for substituting string variables with other strings. More...
interface	XStringWidth
	An interface that encapsulates the abstract notion of string width. More...
interface	XTextSearch
	enables an object to search in its content. More...
interface	XTextSearch2
	enables an object to search in its content. More...
interface	XTheme
	Theme interface. More...
interface	XTimeStamped
	provides timestamp information for an object in the form of an arbitrary string. More...
interface	XUniqueIDFactory
	creates IDs which are unique within the container. More...
interface	XUpdatable
	is supported by objects with data that can be updated from a data source. More...
interface	XUpdatable2
	This interface extends XUpdatable in order to provide more fine-tuned update modes. More...
interface	XURLTransformer
	supports parsing and assembling of URLs More...
interface	XVeto
	provides information about a veto which has been raised against an operation More...

Typedefs
typedef sequence< ElementChange >	ChangesSet
	describes a set of changes occurring as a batch transaction. More...
typedef long	Color
	describes an RGB color value with an optional alpha channel. More...
typedef short	Language
	This type is used for a language identifier number. More...

Enumerations
enum	DataEditorEventType { DONE, CANCELED }
	specifies the type of an event from an XDataEditor. More...
enum	SearchAlgorithms { ABSOLUTE, REGEXP, APPROXIMATE }
enum	SortFieldType { AUTOMATIC, NUMERIC, ALPHANUMERIC }
	enumeration used to specify the type of contents in a sort field. More...
enum	TriState { NO, YES, INDETERMINATE }
	This enumeration represents a tristate value. More...

Detailed Description

Miscellaneous interfaces for sorting, connecting objects etc.

Typedef Documentation

ChangesSet

typedef sequence<ElementChange> ChangesSet

published

describes a set of changes occurring as a batch transaction.

See also

XChangesBatch

XChangesSet

ChangesEvent

ElementChange

Color

typedef long Color

published

describes an RGB color value with an optional alpha channel.

The byte order is from high to low:

1. alpha channel
2. red
3. green
4. blue

Language

typedef short Language

published

This type is used for a language identifier number.

Enumeration Type Documentation

DataEditorEventType

enum DataEditorEventType

published

specifies the type of an event from an XDataEditor.

Enumerator
DONE	specifies that the data editing is done (data stored).
CANCELED	specifies that the data editing was canceled by the user (data not stored).

SearchAlgorithms

enum SearchAlgorithms

published

Enumerator
ABSOLUTE	Literal.
REGEXP	Regular expression.
APPROXIMATE	Weighted Levenshtein Distance.

SortFieldType

enum SortFieldType

published

enumeration used to specify the type of contents in a sort field.

Deprecated:

Enumerator
AUTOMATIC	type is determined automatically.
NUMERIC	sort field contains numerical data.
ALPHANUMERIC	sort field contains text data.

TriState

enum TriState

This enumeration represents a tristate value.

This enumeration defines three values, TRUE, FALSE and a don't know value.

Enumerator
NO	The value is equivalent to FALSE.
YES	The value is equivalent to TRUE.
INDETERMINATE	The value is indeterminate.