From 9f12a9da8d91364d4d0865021adbe62bfa09148c Mon Sep 17 00:00:00 2001
From: Michael Stahl There can be zero, one, or more key bindings. Each key binding consists
- of a sequence of Use one value out of the constant group
-
@@ -61,7 +61,7 @@ service AccessibleIconChoiceControlEntry
>AccessibleStateType::DEFUNC
is set if the object has already been disposed
and subsequent calls to this object result in
-
@@ -59,7 +59,7 @@ service AccessibleListItem
>AccessibleStateType::DEFUNC
is set if the object has already been disposed
and subsequent calls to this object result in
-
@@ -66,7 +66,7 @@ service AccessibleTreeListBoxEntry
>AccessibleStateType::DEFUNC
is set if the object has already been disposed
and subsequent calls to this object result in
-
Use one value out of the constant group
-
Use one value out of the constant group
-
Use one value out of the constant group
-
Use one value out of the constant group
-
One or more values out of the constant group
-
Zero or more constants from the
-
Zero or more constants from the group
-
This is a constant from the constant group
-
This is a constant from the constant group
-
A menu bar can only be used by top-level windows. They support
- the interface
Zero ore more constants from the
-
Only
Only
Only
Only
Only
Only
Only
Only
The interfaces
The interfaces com::sun::star::beans::XPropertySet + and com::sun::star::beans::XMultiPropertySet need access to the model data from the embedding environment. The control and the model can specify additional interfaces to exchange data or export more functionality from the model.
diff --git a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl index fc82f07aae35..d500d5c96b85 100644 --- a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl @@ -78,13 +78,13 @@ published service UnoControlNumericFieldModel [property] com::sun::star::awt::FontDescriptor FontDescriptor; - /** specifies theOnly
Only
Only
Only
This flag may be ignored, but in this case no system-dependent diff --git a/offapi/com/sun/star/awt/WindowDescriptor.idl b/offapi/com/sun/star/awt/WindowDescriptor.idl index dcbbe1c4e3ea..5760950583bb 100644 --- a/offapi/com/sun/star/awt/WindowDescriptor.idl +++ b/offapi/com/sun/star/awt/WindowDescriptor.idl @@ -144,7 +144,7 @@ published struct WindowDescriptor /** specifies the window attributes.
Use one value out of the constant group
-
0
,
and smaller than or equal to the value returned by i_index
is not a valid index.
@@ -116,7 +116,7 @@ interface XAnimatedImages
and smaller than the value returned by i_index
is not a valid index.
diff --git a/offapi/com/sun/star/awt/XContainerWindowEventHandler.idl b/offapi/com/sun/star/awt/XContainerWindowEventHandler.idl
index 2e8e83ec9f80..96d268f3d2a3 100644
--- a/offapi/com/sun/star/awt/XContainerWindowEventHandler.idl
+++ b/offapi/com/sun/star/awt/XContainerWindowEventHandler.idl
@@ -30,7 +30,7 @@ module com { module sun { module star { module awt {
/** Handles events fired by windows represented by a
- All properties are vetoable properties. If you change the properties
between
SortableGridDataModel
- For string comparison, a default
For string comparison, a default ::com::sun::star::i18n::Collator, based on the system's locale, will be used.
@param DelegatorModel diff --git a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl index ffeecce4406d..5c14ea11ba89 100644 --- a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl +++ b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module awt { module grid { */ published service UnoControlGridModel { - /** specifies the standard model of anThe width is specified in application font units - see
The width is specified in application font units - see com::sun::star::util::MeasureUnit.
The value given here is ignored if
The height is specified in application font units - see
The height is specified in application font units - see com::sun::star::util::MeasureUnit.
The value given here is ignored if
The height is specified in application font units - see
The height is specified in application font units - see com::sun::star::util::MeasureUnit.
*/ [property, maybevoid] long RowHeight; @@ -215,12 +215,12 @@ published service UnoControlGridModel */ [property, maybevoid] com::sun::star::util::Color TextLineColor; - /** specifies theIf you are interested in knowing when the selection changes implement a
-
If you are interested in detecting either double-click events or when a user clicks on a node,
- regardless of whether or not it was selected, you can get the
The list of objects that implement this service is
-
The
-
Focus handling depends on support of the
-
Key bindings are not supported at the moment
@@ -155,7 +155,7 @@ service AccessibleChartElementThis interface is used primarily to provide the predominant
foreground and background colors and—if applicable, i.e. the
-
The text/font properties which are specified in the service
-
Different Diagram Types, e.g., PieDiagram or
LineDiagram, can be instantiated by the
-
The
The com::sun::star::beans::XPropertySet
given here must support the services
-
The
The com::sun::star::beans::XPropertySet
given here must support the services
-
It should provide templates for all properties in this service, thus it must also support DataPoint.
diff --git a/offapi/com/sun/star/chart2/DataPointProperties.idl b/offapi/com/sun/star/chart2/DataPointProperties.idl index 7c7b15e644df..e9b5fd14a26e 100644 --- a/offapi/com/sun/star/chart2/DataPointProperties.idl +++ b/offapi/com/sun/star/chart2/DataPointProperties.idl @@ -129,10 +129,10 @@ service DataPointProperties [property] ::com::sun::star::drawing::LineDash BorderDash; /** The name of a dash that can be found in the -The
The com::sun::star::beans::XPropertySet must support the service ErrorBar.
*/ [optional, maybevoid, property] com::sun::star::beans::XPropertySet ErrorBarX; @@ -288,7 +288,7 @@ service DataPointProperties /** If void, no error bars are shown for the data point in y-direction. -The
The com::sun::star::beans::XPropertySet must support the service ErrorBar.
*/ [optional, maybevoid, property] com::sun::star::beans::XPropertySet ErrorBarY; diff --git a/offapi/com/sun/star/chart2/DataSeries.idl b/offapi/com/sun/star/chart2/DataSeries.idl index 1f1d9a048dde..bf7b9b9964b6 100644 --- a/offapi/com/sun/star/chart2/DataSeries.idl +++ b/offapi/com/sun/star/chart2/DataSeries.idl @@ -97,16 +97,16 @@ service DataSeries /** gives access to the data points contained in a data series.The objects returned by the
-
As the service
-
When the model is stored, the data provider will also be diff --git a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl index 555794e16d4a..925412652595 100644 --- a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl +++ b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl @@ -208,7 +208,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface the changed settings to the default.
If for example the template changed the
-
With the optional
-
The key identifies a number format in an
-
The number format key must be valid for the
-
If a LabeledDataSequence is cloned, it has to
query its contents for the
-
Generally it is not possible to navigate the parent or siblings, if any,
- of this element, so
Clients may register an
Clients may register an com::sun::star::lang::XEventListener to be notified when the object is disposed for either cause.
*/ @@ -101,13 +101,13 @@ published service AccessRootElement /** allows registering listeners that observe the whole hierarchy.A client can register an
-
An implementation will collect as many changes as possible into a single
-
diff --git a/offapi/com/sun/star/configuration/AdministrationProvider.idl b/offapi/com/sun/star/configuration/AdministrationProvider.idl index 073ab9b8abee..1b185d88ec2d 100644 --- a/offapi/com/sun/star/configuration/AdministrationProvider.idl +++ b/offapi/com/sun/star/configuration/AdministrationProvider.idl @@ -43,7 +43,7 @@ module com { module sun { module star { module configuration { default data which is accessible through this service.
An implementation is usually obtained from a
-
The configuration should support explicit access to default values
- (implementing
An implementation is usually obtained from a
-
Some arguments for
"locale"
: "locale"
: com::sun::star::lang::LocaleThe owner of the provider may dispose of this object
using
This service is deprecated,
-
Using the
Using the com::sun::star::registry::XSimpleRegistry
interface, the service can be bound to a subtree within the
configuration tree, as provided by an
-
Thus anybody using this service is strongly advised to read and understand the specification
- of an configuration provider (
As specified for the
-
This object is accessible as singleton theDefaultProvider
. diff --git a/offapi/com/sun/star/configuration/GroupAccess.idl b/offapi/com/sun/star/configuration/GroupAccess.idl index fca524dd595d..421ba0380a67 100644 --- a/offapi/com/sun/star/configuration/GroupAccess.idl +++ b/offapi/com/sun/star/configuration/GroupAccess.idl @@ -70,13 +70,13 @@ published service GroupAccessIf such elements occur as properties or subproperties of an implementation,
it is not specified whether direct subproperty access using
-
Similarly, information about such descendants may not be available from
- the
This service extends the interface
-
Changes can be observed by registering a listener with interface
-
Elements of this group may be replaced only if they are of simple type. diff --git a/offapi/com/sun/star/configuration/HierarchyAccess.idl b/offapi/com/sun/star/configuration/HierarchyAccess.idl index 1b3bcf1f99c6..912f89409cf4 100644 --- a/offapi/com/sun/star/configuration/HierarchyAccess.idl +++ b/offapi/com/sun/star/configuration/HierarchyAccess.idl @@ -75,9 +75,9 @@ published service HierarchyAccess /** provides support for inexact names.
Exact names can be obtained for simple or hierarchical names for use in
-
This interface may be missing, if the hierarchy supports no traits that are
- described by
If a child of this node is an object that implements
-
This interface may be missing, if the hierarchy supports no traits that are
- described by
If the parent of this object implements
-
If the parent of this object implements
-
Interface
Interface com::sun::star::configuration::XTemplateContainer, which is optional in SimpleSetAccess must always be implemented in this service, if the elements are of object type.
*/ diff --git a/offapi/com/sun/star/configuration/SetElement.idl b/offapi/com/sun/star/configuration/SetElement.idl index 8a37279311f2..60795e02f570 100644 --- a/offapi/com/sun/star/configuration/SetElement.idl +++ b/offapi/com/sun/star/configuration/SetElement.idl @@ -41,8 +41,8 @@ module com { module sun { module star { module configuration {New set element instances generally are created through members of
-
When a set element is removed from its set from outside the hierarchy, the
container disposes of the object. This occurrence can be detected by registering
- a
If an implementation is part of a read-only view of the hierarchy,
@@ -126,7 +126,7 @@ published service SetElement
returns
Clients may register an
Clients may register an com::sun::star::lang::XEventListener to be notified, if the object is removed from its container by an outside source.
*/ @@ -139,13 +139,13 @@ published service SetElementIf the object was created using interface
-
If the object was created using interface
-
Changes can be observed by registering a listener with interface
-
If the elements of this set are of object type, new elements are constructed
to match the tree structure prescribed by the element template of this set, when
- using interfaces
Objects that are removed from a set can be reinserted into any set supporting diff --git a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl index d2b2e31a486f..990f7240e893 100644 --- a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl +++ b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl @@ -49,12 +49,12 @@ published service SimpleSetUpdate /** allows inserting, removing, and replacing elements.
This interface extends the interface
-
If available, changes can be observed by registering a listener with interface
-
If the elements of this set are of simple type (the type returned by @@ -67,8 +67,8 @@ published service SimpleSetUpdate
Otherwise new elements have to be constructed to match the type
prescribed by the element template of this set. Such elements can be created
- using interfaces
Objects to be inserted must not be contained in any set at the time of
@@ -147,7 +147,7 @@ published service SimpleSetUpdate
to be built. The implementation must at least support using the template
name obtained from
The accumulated changes within this hierarchy can be managed using
-
An implementation will also implement
-
If multiple templates are supported, the supported factory interface may be
-
If this interface is present, a SingleBackend
may be passed, that is used to access the data.
- Also a
If this interface is missing, the real backend to use is determined
- from the
May be a numeric error code, a message
This interface, which is optional in Importer
is mandatory in this service and supports the following arguments
which must be provided as
-
Overwrite
: If
This object is accessible as singleton within the context
. diff --git a/offapi/com/sun/star/configuration/backend/Importer.idl b/offapi/com/sun/star/configuration/backend/Importer.idl index dd57765e7a0a..f96238abffcb 100644 --- a/offapi/com/sun/star/configuration/backend/Importer.idl +++ b/offapi/com/sun/star/configuration/backend/Importer.idl @@ -47,7 +47,7 @@ published service Importer its behavior . Arguments are provided as
-
The continuation restrictions are as follows: Let C be the
subset of the provided continuations that are of type
-
The arguments must be a sequence of
-
"Parent"
of type
- "Context"
of type Call "Source"
and
Implementations can provide more arguments to fine tune the behavior.
Such arguments are provided as
-
Overwrite
: OverwriteExisting =
If
For example the following exceptions may be used:
If present a type
-
If the implementation supports
-
The configuration layer XML from a given stream is parsed and fed to a
-
The source can be passed
- as a
The configuration layer data described to a
-
The target can be passed
- as a
The configuration schema XML from a given stream is parsed and fed to a
-
The source can be passed
- as a
The contained settings are used to initialize the
-
The implementation is usually available as a singleton in the context diff --git a/offapi/com/sun/star/configuration/theDefaultProvider.idl b/offapi/com/sun/star/configuration/theDefaultProvider.idl index f0473beb16ae..16e280ee3494 100644 --- a/offapi/com/sun/star/configuration/theDefaultProvider.idl +++ b/offapi/com/sun/star/configuration/theDefaultProvider.idl @@ -20,7 +20,7 @@ module com { module sun { module star { module configuration { The default ConfigurationProvider.
This singleton somewhat arbitrarily makes available the
-
A NULL value is not allowed.
@throws com::sun::star::datatransfer::UnsupportedFlavorException - if the givenNotes: The Unix implementation needs to be instantiated with 2 Arguments:
If the given
If the given com::sun::star::datatransfer::XTransferable + has no com::sun::star::datatransfer::DataFlavor the clipboard will be deleted.
A NULL value is not allowed.
diff --git a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl index a6279963ee76..db548afd8bf0 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl @@ -38,7 +38,7 @@ published struct DragGestureEvent: com::sun::star::lang::EventObject /** The action selected by the user.Different constants may be combined using a logical OR.
It's further possible to combine the ACTION_DEFAULT with one of the other - actions defined inThe initial trigger event will presumably be a
The initial trigger event will presumably be a com::sun::star::awt::MouseEvent event. If it is not, the implementation should either react accordingly or presume that the left mouse button was clicked.
*/ diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl index 1de0087fca09..9b2b38366938 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module datatransfer { module dnd { associated with a Drag and Drop operation enters the visible geometry of a window associated with a drop target. -It contains the
It contains the com::sun::star::datatransfer::DataFlavor types supported by the transferable object of the current Drag and Drop operation.
@see com::sun::star::datatransfer::XTransferable @@ -39,7 +39,7 @@ module com { module sun { module star { module datatransfer { module dnd { published struct DropTargetDragEnterEvent: DropTargetDragEvent { - /** A sequence of supportedThis exception is intended to be used with an
-
This exception is intended to be used with an
-
This exception is intended to be used with an
-
Context strings other than "user"
, "shared"
will last in an
-
A default interaction handler is available as service
-
Every container item is specified as a set of properties and will be
- represented by a sequence<
After a generic TypeDetection an internal type name
- will be known. Further a generic
Proposed behavior
Searching of a suitable filter for a given internal type name, must be done by the new interface
-
How it can be distinguished?
- The new proposed implementation will throw an
Every filter, which was created by this factory can(!) be initialized with it's own configuration data
and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the filter
- instance must support the optional interface
Every container item is specified as a set of properties and will be
- represented by a sequence<
The
The com::sun::star::container::XNameAccess returns elements + of com::sun::star::beans::XPropertySet that implement the service LinkTarget.
*/ published service LinkTargets diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl index 11cef721a891..0d8c3aae6365 100644 --- a/offapi/com/sun/star/document/MediaDescriptor.idl +++ b/offapi/com/sun/star/document/MediaDescriptor.idl @@ -227,7 +227,7 @@ service MediaDescriptor the other properties. It is not allowed to keep a reference to this InputStream after loading the component, and it would be useless, because in general an InputStream is usable for reading only once, except when it - also implements the
- Object implementing the
Type of the medium to load, that must match to one of the types defined
in the TypeDetection configuration (otherwise it's ignored).
- This bypasses the type detection of the
- Object implementing the
Data to set a special view state after loading. The type depends on
- the component and is usually retrieved from a
If during loading time the filter can't be detected and wasn't given at calling time,
- a possible
All major document-like components should support this service
- instead of simple components which supports a
The data source can e.g. be used for feeding a form diff --git a/offapi/com/sun/star/document/TypeDetection.idl b/offapi/com/sun/star/document/TypeDetection.idl index bb958dea1933..1fd3eac9fa3f 100644 --- a/offapi/com/sun/star/document/TypeDetection.idl +++ b/offapi/com/sun/star/document/TypeDetection.idl @@ -43,7 +43,7 @@ published service TypeDetection
Use this interface to get information about the type of the given resource.
Return value will be always an internal name of a registered document type.
- It can be used may on other services (e.g.
Every container item is specified as a set of properties and will be
- represented by a sequence<
In the case of transforming an URL to binary data, the getInputStream
- method is used. This returns a
In the case of transforming binary data to an URL, a
- resolveOutputStream
method can
be used to transform the binary data, represented through the
-
If during loading time the filter can't be detected and wasn't given at calling time,
- a possible
The
The
The storage must represent OOXML format and support
-
The returned objects implement at least the interface
-
All actions will be removed from both the Undo and the Redo stack. Actions which implement the
-
All actions will be removed from the Redo stack. Actions which implement the
All actions will be removed from the Redo stack. Actions which implement the com::sun::star::lang::XComponent interface will be disposed.
@throws UndoContextNotClosedException diff --git a/offapi/com/sun/star/document/XViewDataSupplier.idl b/offapi/com/sun/star/document/XViewDataSupplier.idl index 0dc6db77573d..c02bc152be8a 100644 --- a/offapi/com/sun/star/document/XViewDataSupplier.idl +++ b/offapi/com/sun/star/document/XViewDataSupplier.idl @@ -39,8 +39,8 @@ published interface XViewDataSupplier: com::sun::star::uno::XInterface /** retrieve information about currently opened view to restore it later @returns - aSee AccessibleShape for documentation and support of
the interfaces
-
If this state is set then no other of the states below is
set. This is also true for the states that are otherwise
diff --git a/offapi/com/sun/star/drawing/Background.idl b/offapi/com/sun/star/drawing/Background.idl
index b919df358e9f..eff312c59a06 100644
--- a/offapi/com/sun/star/drawing/Background.idl
+++ b/offapi/com/sun/star/drawing/Background.idl
@@ -26,7 +26,7 @@ module com { module sun { module star { module drawing {
/** this service provides the properties to describe a background filling for
- a drawing page. It can be obtained by the
The following services are all
The following services are all com::sun::star::text::TextField + and can be inserted into text as com::sun::star::text::TextContent.
The following service can be set at the Numbering
property
- inside a
The following services can be used for a
The following services can be used for a com::sun::star::image::ImageMap
inside the document.
-
A
A com::sun::star::image::ImageMap can be obtained from a
GraphicObjectShape
The following services lets you access the drawing property defaults of a document.
It is used for example to access the
It is used for example to access the com::sun::star::awt::Gradients that
are used inside a document.
@see DrawingDocumentFactory
@@ -35,7 +35,7 @@
*/
published service GradientTable
{
- /** this container lets you access the
Note: You can add new entries for later use, but you cannot
diff --git a/offapi/com/sun/star/drawing/Shape.idl b/offapi/com/sun/star/drawing/Shape.idl
index 3f7b16d32946..6345a85d1e36 100644
--- a/offapi/com/sun/star/drawing/Shape.idl
+++ b/offapi/com/sun/star/drawing/Shape.idl
@@ -68,7 +68,7 @@ published service Shape
/** This interfaces gives access to an optional container of glue points.
To have unique ids you should query the returned interface for
-
The different rules accessible with this
-
It is used for example to access the
It is used for example to access the com::sun::star::awt::Gradients that
are used inside a document for fill transparency.
@see DrawingDocumentFactory
@@ -35,7 +35,7 @@
*/
published service TransparencyGradientTable
{
- /** this container lets you access the
Note: You can add new entries for later use, but you cannot diff --git a/offapi/com/sun/star/drawing/XDrawSubController.idl b/offapi/com/sun/star/drawing/XDrawSubController.idl index 94cb7030be9a..3126cfa53697 100644 --- a/offapi/com/sun/star/drawing/XDrawSubController.idl +++ b/offapi/com/sun/star/drawing/XDrawSubController.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module drawing { /** View dependent part of the Draw and Impress controller.
During the lifetime of an Impress application the
-
The following properties from the
-
Ask the interface
Ask the interface com::sun::star::document::XMimeTypeInfo for all values supported by the component.
- Usually a
- Usually a
diff --git a/offapi/com/sun/star/embed/FileSystemStorageFactory.idl b/offapi/com/sun/star/embed/FileSystemStorageFactory.idl index fb3b88b25051..0ee7c960f45e 100644 --- a/offapi/com/sun/star/embed/FileSystemStorageFactory.idl +++ b/offapi/com/sun/star/embed/FileSystemStorageFactory.idl @@ -59,10 +59,10 @@
diff --git a/offapi/com/sun/star/embed/StorageFactory.idl b/offapi/com/sun/star/embed/StorageFactory.idl index a07e9777b986..800ac9fbaccd 100644 --- a/offapi/com/sun/star/embed/StorageFactory.idl +++ b/offapi/com/sun/star/embed/StorageFactory.idl @@ -47,13 +47,13 @@
In case the storage stream is open readonly the returned reference
- to
In case a stream is disposed any call to it's methods should result in
-
The component may not support
-
In case specified entry exists it's contents are ignored and will
be overwritten on storing.
@@ -142,7 +142,7 @@ published interface XEmbedObjectCreator: com::sun::star::uno::XInterface
@param aMediaDescriptor
an object of type
-
If storage does not allow any encryption this method will always throw
-
diff --git a/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl b/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl index e0914af8f5ce..8dac7d7f91e4 100644 --- a/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl +++ b/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl @@ -34,7 +34,7 @@ interface XHierarchicalStorageAccess2 : XHierarchicalStorageAccess
If storage does not allow any encryption this method will always throw
-
diff --git a/offapi/com/sun/star/embed/XInplaceClient.idl b/offapi/com/sun/star/embed/XInplaceClient.idl
index ded84a79fa85..795ba4afcca5 100644
--- a/offapi/com/sun/star/embed/XInplaceClient.idl
+++ b/offapi/com/sun/star/embed/XInplaceClient.idl
@@ -85,12 +85,12 @@ interface XInplaceClient: com::sun::star::uno::XInterface
raises( ::com::sun::star::embed::WrongStateException );
/** allows to retrieve the
-
@@ -53,13 +53,13 @@ published interface XLinkCreator: com::sun::star::uno::XInterface
a name for the entry
@param aArgs
-
In case a storage is disposed any call to it's methods should result
- in
If storage does not allow any encryption this method will always throw
-
@@ -261,7 +261,7 @@ published interface XStorage
If storage does not allow any encryption this method will always throw
-
diff --git a/offapi/com/sun/star/embed/XStorage2.idl b/offapi/com/sun/star/embed/XStorage2.idl index b247fa3f40d2..7d3ae844dfaa 100644 --- a/offapi/com/sun/star/embed/XStorage2.idl +++ b/offapi/com/sun/star/embed/XStorage2.idl @@ -34,7 +34,7 @@ interface XStorage2 : XStorage
If storage does not allow any encryption this method will always throw
-
@@ -89,7 +89,7 @@ interface XStorage2 : XStorage
If storage does not allow any encryption this method will always throw
-
diff --git a/offapi/com/sun/star/embed/XTransferableSupplier.idl b/offapi/com/sun/star/embed/XTransferableSupplier.idl
index 51e4ff2747f3..9de5edaef4f7 100644
--- a/offapi/com/sun/star/embed/XTransferableSupplier.idl
+++ b/offapi/com/sun/star/embed/XTransferableSupplier.idl
@@ -25,17 +25,17 @@
module com { module sun { module star { module embed {
/** provide access to a
-
The connection between a data-aware control model and a form whose data the
control should display is made by parentship relations. The parent of a data-aware
- control model (see
In the context of a control model which is data-aware, the semantics of default value
(see XReset) is as follows:
- If (and only if) the control is valid bound to a column of it's
In all other cases, the model is reset to the default value as specified by the respective property.
For an example, have a look at the
For an example, have a look at the com::sun::star::form::component::TextField. It inherits
the
In the context of a
In the context of a com::sun::star::form::component::DataForm, controls are automatically reset when one of the following applies
This property makes sense in the context of the control model only. Normally, a control model
- is a child of a
This member here describes the column of this result set which the control should act for.
Applies only if the form the control model belongs to is loaded and the control is valid bound.
- The referenced field supports the
When setting the property, a number of constraints apply:
Usually, a
Usually, a com::sun::star::form::component::DataForm fires this event when loading the form requires parameters to be filled in.
-Every parameter object supports the
Every parameter object supports the com::sun::star::beans::XPropertySet interface, and at least the properties Name and Value
@see com::sun::star::sdb::RowSet diff --git a/offapi/com/sun/star/form/FormComponent.idl b/offapi/com/sun/star/form/FormComponent.idl index 8d3aa13c50cd..d81cdc554b51 100644 --- a/offapi/com/sun/star/form/FormComponent.idl +++ b/offapi/com/sun/star/form/FormComponent.idl @@ -70,7 +70,7 @@ published service FormComponent properties.Additionally, you can add more properties to the component as needed,
- using the
Dynamic properties are not evaluated by the component itself, @@ -90,7 +90,7 @@ published service FormComponent /** the name of the component.
Note that the name accessed here is the same as when using the
-
The interface allows managing of scripts associated with dependent components, accessed by index.
However, as a client of the FormComponents service, there's no need to bother with
- the container aspect of the
For instance, at any time you can obtain the events associated with the n
Basically, a Forms is a FormComponents,
with the additional restriction that the contained elements support the
-
The controller can be plugged into an
The controller can be plugged into an com::sun::star::frame::XFrame, and will provide a visual component for inspecting control properties. This means it allows to interactively control several aspects of a FormControlModel or DataAwareControlModel, such as it's data binding, it's layout, and it's event binding
@@ -68,8 +68,8 @@ @deprecatedNote that nowadays, this service is only a legacy wrapper using the
-
With supporting this interface, the component is able to operate in (and provide content
- for) an
Usually, a component which supports the
XApproveActionBroadcaster interface implements
-
This interface is usually implemented by components which are to execute a statement,
and may need parameter information. For example, the
-
Please do not use anymore, this interface is superseded
- by
Please do not use anymore, this interface is superseded
- by
Please do not use anymore, this interface is superseded
- by
The interface allows managing of scripts associated with dependent components, accessed by index.
However, as a client of the FormComponents service, there's no need to bother with
- the container aspect of the
For instance, at any time you can obtain the events associated with the n
Note that a grid control does not allow free control over the current row:
In such a control, every line represents a row of data of the underlying
-
The current column of a grid control, whoever, can be freely controlled.
This interface allows to retrieve data even for rows which are not current, which is quite useful,
as normally, you can't affect the current row in a grid control without moving the cursor of the underlying
-
Please do not use anymore, this interface is deprecated, and
- superseded by functionality from the
Please do not use anymore, this interface is deprecated, and
- superseded by functionality from the
Please do not use anymore, this interface is deprecated, and
- superseded by functionality from the
Usually, this is used by
Usually, this is used by com::sun::star::form::component::HTMLForms.
See the HTML specification to learn about submitting forms.
diff --git a/offapi/com/sun/star/form/XSubmitListener.idl b/offapi/com/sun/star/form/XSubmitListener.idl index eb68f4d1b562..87f6cb3df180 100644 --- a/offapi/com/sun/star/form/XSubmitListener.idl +++ b/offapi/com/sun/star/form/XSubmitListener.idl @@ -36,7 +36,7 @@ @see XSubmit @deprecated - This interface is superseded by theVia this service, bindable control models inherit the
-
+ com::sun::star::util::XCloneable interface.
If an bindable control model, at which a binding has been established (via
Control models usually have some kind of value property, which reflects the very current
content of the controls associated with this model. For instance, for an
-
Usual
Usual com::sun::star::form::DataAwareControlModels can be bound to
+ a column of a com::sun::star::form::component::DataForm, and exchange
their content with such a column.
- In particular, when the
On the other hand, when any change in the control model (e.g. resulting from a user entering
data in a control associated with the control model) is committed
(
BindableDataAwareControlModel's additionally support an alternative value
binding, which forces them to exchange their value with another foreign instance.
In some sense, they are an abstraction of the data aware control models, which only
support a specialized, hard-coded value binding (namely the binding to a
-
For this, they provide the XBindableValue interface which allows to set an external component to exchange the value with.
@@ -68,21 +68,21 @@ module com { module sun { module star { module form { module binding {The
The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseCheckBox must support exchanging boolean values. The following mapping between external values and control states apply:
If an
If an com::sun::star::form::binding::ValueBinding instance is
set at the field, it will exchange it's text with the binding as string, thus only
bindings supporting string exchange will be accepted in
If an
If an com::sun::star::form::binding::ValueBinding instance is + set at the field, it will exchange it's content with the binding as com::sun::star::util::Date.
@see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl index 37fedc23ac5d..b463892f3001 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a formatted input field which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. -The
The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseFormattedField must support exchanging values of type double.
diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl index 511acfb6e3fd..f8c0eb96fdb7 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a numeric input field which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. -The
The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseNumericField must support exchanging values of type double.
diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl index c7eb5fbb2b0c..81d86b04d0b9 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a radio button which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. -The
The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseRadioButton must support exchanging boolean values. The following mapping between external values and control states apply:
If an
If an com::sun::star::form::binding::ValueBinding instance is
set at the field, it will exchange it's text with the binding as string, thus only
bindings supporting string exchange will be accepted in
If an
If an com::sun::star::form::binding::ValueBinding instance is + set at the field, it will exchange it's content with the binding as com::sun::star::util::Time.
@see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/XListEntrySource.idl b/offapi/com/sun/star/form/binding/XListEntrySource.idl index db1f0efcbf30..5d51089d574f 100644 --- a/offapi/com/sun/star/form/binding/XListEntrySource.idl +++ b/offapi/com/sun/star/form/binding/XListEntrySource.idl @@ -45,7 +45,7 @@ interface XListEntrySource : com::sun::star::uno::XInterface /** provides access to a single list entry - @throwsThis property is evaluated if the button is of type URL.
As always, there is a number of target names which have a special meaning, and force
- a special
For a given implementation of the interface, if this (optional) property is present, then also the optional
- interface
The insertion row is a virtual row which is used to insert new records. It is reached
by calling
You can add your component as
-
In a first approach, the form tries to fill any parameters from it's master-detail relation
(if any). All values which can't be filled are then passed to all listeners, which can
diff --git a/offapi/com/sun/star/form/component/DatabaseImageControl.idl b/offapi/com/sun/star/form/component/DatabaseImageControl.idl
index b6e102c913e0..02984b1f6eef 100644
--- a/offapi/com/sun/star/form/component/DatabaseImageControl.idl
+++ b/offapi/com/sun/star/form/component/DatabaseImageControl.idl
@@ -32,7 +32,7 @@
/** specifies the model of a control used for displaying images stored in a database.
-
As every
As every com::sun::star::form::DataAwareControlModel, an image control
can be bound to a database field. This means that for instance with every record change, the content
of the database field is taken, interpreted as image, and displayed in the control.
Unlike other more text-based controls, it does not interpret the content of the field as text or double,
@@ -54,10 +54,10 @@
In a usual data form, the scenario will be as follows:
Other components can register as
Other components can register as com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.
*/ interface com::sun::star::form::XImageProducerSupplier; diff --git a/offapi/com/sun/star/form/component/DatabaseListBox.idl b/offapi/com/sun/star/form/component/DatabaseListBox.idl index ba078d84150f..54df8a5ef802 100644 --- a/offapi/com/sun/star/form/component/DatabaseListBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseListBox.idl @@ -118,7 +118,7 @@ published service DatabaseListBox determines the query which the list result set should be based on.Columns of a grid control are modeled by own objects, too. They are very similar to usual
-
All the container-related methods of this service related to control models, this is what are the container elements for a GridControl.
-As the
As the com::sun::star::form::FormComponents service also specifies
the
The only sense of a hidden control is to store data in the form which is not visible to the user.
-Usually, hidden controls are used in
Usually, hidden controls are used in com::sun::star::form::component::HTMLForms,
where they contain data which is to be submitted.
Nevertheless, you can use them in your own forms for storing any data, for instance
to evaluate it in some scripting macro.
Other components can register as
Other components can register as com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.
Whenever the
Usually, controls acting for an ImageButton model are consumers, and use the
data stream to display the image
This property is evaluated if the button is of type URL.
As always, there is a number of target names which have a special meaning, and force
- a special
The value must be one of the
The value must be one of the com::sun::star::text::FontRelief constants.
*/ [property] long FontRelief; /** specifies the emphasis mark for the font described inThe value must be one of the
The value must be one of the com::sun::star::text::FontEmphasis constants.
*/ [property] long FontEmphasisMark; diff --git a/offapi/com/sun/star/form/component/RadioButton.idl b/offapi/com/sun/star/form/component/RadioButton.idl index 25017b23e0ba..aa96b251c380 100644 --- a/offapi/com/sun/star/form/component/RadioButton.idl +++ b/offapi/com/sun/star/form/component/RadioButton.idl @@ -70,7 +70,7 @@ published service RadioButton form.If the form the control belongs to is to be submitted (see
-
If this is set to
If the property is set to
Note that the control model itself will not make any use of the submission.
Instead, submissions are triggered by a control (not a control model).
- Thus, the
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::CheckBox service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/ComboBox.idl b/offapi/com/sun/star/form/control/ComboBox.idl index 68ca2dd2099c..91a7b9e4d1a2 100644 --- a/offapi/com/sun/star/form/control/ComboBox.idl +++ b/offapi/com/sun/star/form/control/ComboBox.idl @@ -29,7 +29,7 @@ /** describes a combo box control. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::ComboBox service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/CommandButton.idl b/offapi/com/sun/star/form/control/CommandButton.idl index d826536e903c..84c646b1f6cb 100644 --- a/offapi/com/sun/star/form/control/CommandButton.idl +++ b/offapi/com/sun/star/form/control/CommandButton.idl @@ -29,7 +29,7 @@ /** describes a button control. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::CommandButton service.
The control is clickable, the action taken upon clicking depends on the settings @@ -45,10 +45,10 @@ published service CommandButton /** allows external instances to register as veto listener for the button's actions. -
An
An com::sun::star::form::XApproveActionListener returning false on
it's approve-method will prevent any action which would usually be triggered - this includes
not only submitting or resetting forms, but also calling the
-
+ com::sun::star::awt::XActionListeners of the super service
This may be interesting for e.g. forms which want to provide input validation before submitting
data.
diff --git a/offapi/com/sun/star/form/control/CurrencyField.idl b/offapi/com/sun/star/form/control/CurrencyField.idl
index 8e3070e8f853..6a44c7e47a28 100644
--- a/offapi/com/sun/star/form/control/CurrencyField.idl
+++ b/offapi/com/sun/star/form/control/CurrencyField.idl
@@ -30,7 +30,7 @@
/** describes a control which can be used for inputting currency values, and
which can (but not necessarily has to) be bound to a database field.
-
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::CurrencyField service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/DateField.idl b/offapi/com/sun/star/form/control/DateField.idl index 0c4622be1a70..90ced2c586e5 100644 --- a/offapi/com/sun/star/form/control/DateField.idl +++ b/offapi/com/sun/star/form/control/DateField.idl @@ -30,7 +30,7 @@ /** describes a control which can be used for inputting date values, and which can (but not necessarily has to) be bound to a database field. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::DateField service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/FilterControl.idl b/offapi/com/sun/star/form/control/FilterControl.idl index c2b32dcefe9c..e42a05c2e454 100644 --- a/offapi/com/sun/star/form/control/FilterControl.idl +++ b/offapi/com/sun/star/form/control/FilterControl.idl @@ -31,7 +31,7 @@ /** describes a check box control which can (but not necessarily has to) be bound to a database field. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::CheckBox service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/FormattedField.idl b/offapi/com/sun/star/form/control/FormattedField.idl index ecc620fbd001..dd5922cfb0e1 100644 --- a/offapi/com/sun/star/form/control/FormattedField.idl +++ b/offapi/com/sun/star/form/control/FormattedField.idl @@ -30,7 +30,7 @@ /** describes a control which can be used for inputting values with a arbitrary formatting, and can (but not necessarily has to) be bound to a database field. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::FormattedField service.
In addition, this control can be used in HTML forms. It triggers the diff --git a/offapi/com/sun/star/form/control/GridControl.idl b/offapi/com/sun/star/form/control/GridControl.idl index 34beb558b29f..0e6332296bd8 100644 --- a/offapi/com/sun/star/form/control/GridControl.idl +++ b/offapi/com/sun/star/form/control/GridControl.idl @@ -42,7 +42,7 @@ module control { /** describes a table-like control for displaying data. -
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::GridControl service.
@see com::sun::star::awt::UnoControl @@ -92,7 +92,7 @@ published service GridControlThe selection used with the methods
- Here the elements of the Sequence are the bookmarks (in the
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::GroupBox service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/ImageButton.idl b/offapi/com/sun/star/form/control/ImageButton.idl index a434200db372..787ec26176ca 100644 --- a/offapi/com/sun/star/form/control/ImageButton.idl +++ b/offapi/com/sun/star/form/control/ImageButton.idl @@ -29,7 +29,7 @@ /** describes a control which can be used for displaying images on a control acting like a button. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::ImageButton service.
The control is clickable, the action taken upon clicking depends on the settings @@ -45,10 +45,10 @@ published service ImageButton /** allows external instances to register as veto listener for the button's actions. -
An
An com::sun::star::form::XApproveActionListener returning false on
it's approve-method will prevent any action which would usually be triggered - this includes
not only submitting or resetting forms, but also calling the
-
+ com::sun::star::awt::XActionListeners of the super service
This may be interesting for e.g. forms which want to provide input validation before submitting
data.
diff --git a/offapi/com/sun/star/form/control/ImageControl.idl b/offapi/com/sun/star/form/control/ImageControl.idl
index 58700d3ab330..9c2f5f5191b4 100644
--- a/offapi/com/sun/star/form/control/ImageControl.idl
+++ b/offapi/com/sun/star/form/control/ImageControl.idl
@@ -29,7 +29,7 @@
/** describes a control used for displaying images stored in a database.
-
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::DatabaseImageControl service.
If the model of the control is valid bound to a database field, the control allows diff --git a/offapi/com/sun/star/form/control/ListBox.idl b/offapi/com/sun/star/form/control/ListBox.idl index 5f15d29f993e..db1c96ad1b1e 100644 --- a/offapi/com/sun/star/form/control/ListBox.idl +++ b/offapi/com/sun/star/form/control/ListBox.idl @@ -30,7 +30,7 @@ /** describes a list box control which can (but not necessarily has to) be bound to a database field. -
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::ListBox service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/NavigationToolBar.idl b/offapi/com/sun/star/form/control/NavigationToolBar.idl index 9c8621cc646c..3b5562749de1 100644 --- a/offapi/com/sun/star/form/control/NavigationToolBar.idl +++ b/offapi/com/sun/star/form/control/NavigationToolBar.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module form { module control { /** This service specifies the model for control which provides controller - functionality for aThe model of the control has to support the
The model of the control has to support the com::sun::star::form::component::NumericField service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/PatternField.idl b/offapi/com/sun/star/form/control/PatternField.idl index 1dba4f96109a..1492362e628b 100644 --- a/offapi/com/sun/star/form/control/PatternField.idl +++ b/offapi/com/sun/star/form/control/PatternField.idl @@ -30,7 +30,7 @@ /** describes a control for inputting text complying to a given pattern, and which can (but not necessarily has to) be bound to a database field. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::PatternField service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/RadioButton.idl b/offapi/com/sun/star/form/control/RadioButton.idl index b0af91cd9e97..33409ecec434 100644 --- a/offapi/com/sun/star/form/control/RadioButton.idl +++ b/offapi/com/sun/star/form/control/RadioButton.idl @@ -29,7 +29,7 @@ /** describes a radio button control which can (but not necessarily has to) be bound to a database field. -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::RadioButton service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/SubmitButton.idl b/offapi/com/sun/star/form/control/SubmitButton.idl index d9157b4a490f..7f3c9a1f6bcf 100644 --- a/offapi/com/sun/star/form/control/SubmitButton.idl +++ b/offapi/com/sun/star/form/control/SubmitButton.idl @@ -29,12 +29,12 @@ module com { module sun { module star { module form { module control { /** specifies a button control which can execute external submissions -The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::SubmitButton service.
The control is clickable. When clicked (by mouse or keyboard, or programmatically), the following happens: -
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::TextField service.
In addition, this control can be used in HTML forms. It triggers the diff --git a/offapi/com/sun/star/form/control/TimeField.idl b/offapi/com/sun/star/form/control/TimeField.idl index d8f567616859..aede8244f96e 100644 --- a/offapi/com/sun/star/form/control/TimeField.idl +++ b/offapi/com/sun/star/form/control/TimeField.idl @@ -30,7 +30,7 @@ /** describes a control for inputting time values which can (but not necessarily has to) be bound to a database field. -
The model of the control has to support the
The model of the control has to support the com::sun::star::form::component::TimeField service.
@see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl index e66018bdae71..6870d53159b2 100644 --- a/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl +++ b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl @@ -26,14 +26,14 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with anFor this, the two properties are superseded by new versions, where as button type, additional
possible values are added for navigating the parent form of the button. For instance, in an
-
The handler expects a value named "ContextDocument" in the context in which it is created.
- That is, the
First, the handler supersedes the HScroll and the VScroll properties of a
First, the handler supersedes the HScroll and the VScroll properties of a com::sun::star::awt::UnoControlEditModel and puts them into one common property, allowing the user to choose whether she want to have "no", a "vertical", a "horizontal", or "both" scrollbars.
-
Second, if it detects a
Second, if it detects a com::sun::star::form::component::RichTextControl to inspect,
it supersedes the
For this, the parent of the form component, which by definition supports the
For this, the parent of the form component, which by definition supports the com::sun::star::form::FormComponent + service, is examined for the com::sun::star::script::XEventAttacherManager interface.
@see com::sun::star::inspection::XPropertyHandler @see com::sun::star::form::component::CommandButton diff --git a/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl index 7c1a366d44f3..4fbe59dfb9f9 100644 --- a/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module form { module inspection { -/** implements the default property handler for all known types ofThe handler expects a value named "ContextDocument" in the context in which it is created.
- That is, the
The handler introduces new properties to choose an
The handler introduces new properties to choose an com::sun::star::xforms::XModel
+ and a com::sun::star::xforms::Binding within this model. Additionally,
it introduces properties which reflect the different facets of the binding (e.g.
The handler expects a value named "ContextDocument" in the context in which it is created.
- That is, the
By using an XMLFormsPropertyHandler, an
By using an XMLFormsPropertyHandler, an com::sun::star::inspection::ObjectInspector
+ can be used to bind form components to com::sun::star::xforms::Binding instances.
Since those instances also support validating form control content (by supporting an
-
The handler expects a value named "ContextDocument" in the context in which it is created.
- That is, the
FormOperations
instance which works on a FormOperations
instance which works on a com::sun::star::form::FormController
instance.
@throws IllegalArgumentException
if the given form controller is FormOperations
instance which works on a FormOperations
instance which works on a com::sun::star::form::component::DataForm
instance.
@throws IllegalArgumentException
- if the given form is This interface supersedes the
This interface supersedes the com::sun::star::form::FormController.
A FormController is responsible for a
A FormController is responsible for a com::sun::star::awt::UnoControlContainer, and all controls therein.
Furthermore, a form controller is responsible for preventing invalid user input. That is, if the form @@ -93,7 +93,7 @@ interface XFormControllerContext;
Alternatively, you can prevent the check on a per-control basis, using the
If a control which the controller is responsible for supports the
If a control which the controller is responsible for supports the com::sun::star::frame::XDispatchProviderInterception interface, the controller registers a dispatch interceptor. Then, the control can try to delegate part of its functionality to the controller by querying the dispatch interceptor for it.
@@ -106,11 +106,11 @@ interface XFormControllerContext; Example: The URL suffix for deleting the current record is deleteRecord, so the complete URL for requesting a dispatcher for this functionality is .uno:FormController/deleteRecord. -Some URLs may require parameters. For this, the sequence of
Some URLs may require parameters. For this, the sequence of com::sun::star::beans::PropertyValues
passed to the
For all URLs, interested parties can register as status listeners (
For all URLs, interested parties can register as status listeners (com::sun::star::frame::XStatusListener)
at the dispatchers, and be notified whenever the functionality associated with the URL becomes enabled or
disabled.
For instance, the URL with the suffix moveToFirst is associated with moving the form to the first
@@ -133,7 +133,7 @@ interface XFormControllerContext;
A form controller listens for deletion events at the form it is responsible for. If and only if no
-
A form controller listens for error events at the form it is responsible for. If and only if no
-
A form controller listens for parameter events at the form it is responsible for. If and only if no
-
As another example, consider that you want to delete the current record from the
- form. You have to take into account any
If you agree that this is ugly to do and maintain, then XFormOperations
is for you. It provides a
There are two methods how the value which is represented by a control model
can interact with other components (well, except the trivial ones accessible
- by using
Via this service, validatable control models inherit the
-
+ com::sun::star::util::XCloneable interface.
If an validatable control model, at which a validator has been set (via
The type of the current value, as well as it's semantics, depend on the service implementing this interface.
-Again, this is a convenience method. For example, for a
Again, this is a convenience method. For example, for a com::sun::star::form::component::FormattedField,
calling this method is equivalent to retrieving the
XFormComponentValidityListeners are called whenever any of the aspects of the validatable form component (the validity flag, or the value) changed.
- @throwsImplementations which do not support dynamic validity constraints should simply ignore this call.
- @throws
This handler doesn't need any frame as target for loading components.
Content handler are registered for content types.
- (See type/filter configuration of
@@ -39,7 +39,7 @@
environment. A controller is a richer component then a pure window, but full featured
components need a XModel interface too.
- (see service
@see com::sun::star::document::OfficeDocument diff --git a/offapi/com/sun/star/frame/DispatchDescriptor.idl b/offapi/com/sun/star/frame/DispatchDescriptor.idl index 790567076377..dcc8b936199f 100644 --- a/offapi/com/sun/star/frame/DispatchDescriptor.idl +++ b/offapi/com/sun/star/frame/DispatchDescriptor.idl @@ -42,7 +42,7 @@ published struct DispatchDescriptor /** specifies the URL of the resource/function
- Must be a full parsed URL. Use service
The internal name is a part of his configuration and will be passed by
the FrameLoaderFactory after creation
- if optional interface
A pop-up menu controller implementation gets initialized with a
-
The internal name is a part of his configuration and will be passed by
the FrameLoaderFactory after creation
- if optional interface
To access the user interface command description of a module, a unique module specifier
must be provided to
To create new documents, use "private:factory/scalc", "private:factory/swriter", etc.
Other special protocols (e.g. "slot:", ".uno") are not allowed and raise
- an
- Simple components may implement a
- A layout manager needs a
diff --git a/offapi/com/sun/star/frame/XLoadable.idl b/offapi/com/sun/star/frame/XLoadable.idl
index b78607476d4d..ab05243f6c55 100644
--- a/offapi/com/sun/star/frame/XLoadable.idl
+++ b/offapi/com/sun/star/frame/XLoadable.idl
@@ -46,7 +46,7 @@ published interface XLoadable: com::sun::star::uno::XInterface
/** loads a component from an URL
@param lArguments
parameters for saving
- (see
@@ -48,7 +48,7 @@
If there is at least one controller, there is by definition a
current controller. And if that controller supports the interface
-
- The
- The
- A pop-up menu controller gets a
@@ -66,7 +66,7 @@ interface XToolbarController : com::sun::star::uno::XInterface
/** requests to create a pop-up window for additional functions.
@return
- a
You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
- method of your
You specify a parameter by passing one (or more)
-
This interface extends the interface
-
This interface extends the interface
-
In case of using VCL Devices, this property should
- hold a
Similar to
-
The sequences are of type
-
Derived from
Derived from com::sun::star::i18n::CalendarItem this provides an additional member for narrow names.
@since LibreOffice 3.5 diff --git a/offapi/com/sun/star/i18n/Currency2.idl b/offapi/com/sun/star/i18n/Currency2.idl index d5b6c3213167..ba8500a5ced2 100644 --- a/offapi/com/sun/star/i18n/Currency2.idl +++ b/offapi/com/sun/star/i18n/Currency2.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module i18n { sequence by It is derived from
-
It is derived from
-
It is derived from
-
It is derived from
-
It is derived from
-
It is derived from
-
It is derived from
-
For example, in English locale it returns
"p." for bMorePages ==
diff --git a/offapi/com/sun/star/i18n/XLocaleData2.idl b/offapi/com/sun/star/i18n/XLocaleData2.idl
index 414102fea71f..bf93479c72fb 100644
--- a/offapi/com/sun/star/i18n/XLocaleData2.idl
+++ b/offapi/com/sun/star/i18n/XLocaleData2.idl
@@ -30,9 +30,9 @@ module com { module sun { module star { module i18n {
Access locale specific data.
Derived from
-
Derived from
Derived from ::com::sun::star::i18n::XLocaleData3 this provides an additional method to return a sequence of date acceptance patterns for a locale. diff --git a/offapi/com/sun/star/inspection/LineDescriptor.idl b/offapi/com/sun/star/inspection/LineDescriptor.idl index fcfb133c774b..d2dc6bad9868 100644 --- a/offapi/com/sun/star/inspection/LineDescriptor.idl +++ b/offapi/com/sun/star/inspection/LineDescriptor.idl @@ -86,13 +86,13 @@ struct LineDescriptor /** describes the URL of an image to display on the primary button, if any. -
This URL will be used to obtain an actual
This URL will be used to obtain an actual com::sun::star::graphic::XGraphic + object from an com::sun::star::graphic::GraphicProvider.
The property will be ignored if
If you need to specify a graphic which does not have an URL, but is available as
- PrimaryButtonImageURL
empty, and use the
This URL will be used to obtain an actual
This URL will be used to obtain an actual com::sun::star::graphic::XGraphic + object from an com::sun::star::graphic::GraphicProvider.
The property will be ignored if
If you need to specify a graphic which does not have an URL, but is available as
- SecondaryButtonImageURL
empty, and use the
The controller can be plugged into an
The controller can be plugged into an com::sun::star::frame::XFrame, and will
provide a visual component for inspecting and modifying component properties.
Note that "property" here is a generic term - any aspect of a component can be considered a property,
as long as some property handler is able to describe this aspect in a property-like way.
Since property handlers might have the need to raise UI, they will be created with a context
value named "DialogParentWindow", which contains an XWindow which should be used as parent of
any windows to raise.
- If the
Controls of type
Additionally, those controls support the XStringListControl interface. If you use this interface to add additional entries to the list box, which have no color associated with it, @@ -106,19 +106,19 @@ constants PropertyControlType /** denotes a control which allows the user to enter a date value -
Controls of type
Controls of type
Controls of type
Controls of type
Controls of type
Controls of type
Only a certain set of
Only a certain set of com::sun::star::util::MeasureUnit values is supported. In particular, every value which denotes a fraction of another unit (like 100th millimeters) cannot be used as DisplayUnit.
@throws com::sun::star::lang::IllegalArgumentException - if the caller attempts to set an unsupportedThe core measurement unit for a property value might differ from the unit which
diff --git a/offapi/com/sun/star/inspection/XObjectInspector.idl b/offapi/com/sun/star/inspection/XObjectInspector.idl
index e005874b0a4d..c6cac35f3cd2 100644
--- a/offapi/com/sun/star/inspection/XObjectInspector.idl
+++ b/offapi/com/sun/star/inspection/XObjectInspector.idl
@@ -37,13 +37,13 @@ interface XObjectInspectorUI;
*/
interface XObjectInspector
{
- /** allows to plug the inspector into an
The
If you do not want to support a full-blown
If you do not want to support a full-blown com::sun::star::frame::XModel,
use the
The
This interface is inherited from the
This interface is inherited from the com::sun::star::frame::Controller service, currently, there is no functionality to intercept at an XObjectInspector.
*/ interface com::sun::star::frame::XDispatchProvider; @@ -66,7 +66,7 @@ interface XObjectInspectorNote that there are two ways of setting or retrieving the current model: You can either
use
If a new model is set at the inspector, the complete UI will be rebuilt to reflect diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index d59c19326d51..e5169c5c4635 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -42,11 +42,11 @@ interface XObjectInspectorModel
This must be the value of a single flag. No combinations are allowed.
- @seeIt must be set if an entry was added or deleted, otherwise it should be empty.
- @seeThese flags represent the type of events that a dictionary may broadcast.
- @seeThe active dictionaries of this list will be used for spell checking and hyphenation.
- @seeThe value can be the combination of multiple
-
It will be empty if all
-
These flags define the possible types for a dictionary-list event.
- @seeThe value may be combined via logical OR from those values
- defined in
These values define the flags which may be logically combined
to build the event type of a
-
A value of this type is part of the
-
The dictionaries added to the list may or may not support the
-
A dictionary to be added must support the
-
The property type must be one of
-
Personal dictionaries are used to supply additional
information for spell checking and hyphenation (see
-
The single method is used by a dictionary to notify its
listeners about
-
This interface is used as a return value for some of the hyphenator functions.
- @seeThis interface may be used by spell checker or hyphenator
implementations to allow clients to be registered and informed about
-
Note: The LinguServiceManager forwards the
-
The function of this interface is used by the
-
For the thesaurus, the behavior is the same when no meaning was found.
- @seeThe listeners may support one or both of
-
- @see
This interface has to be implemented by
-
If the language is not supported, an
-
$(userurl)
.
*/
create( [in] string FileURL );
diff --git a/offapi/com/sun/star/media/Manager.idl b/offapi/com/sun/star/media/Manager.idl
index e4210d4171b9..c5cdf1002c63 100644
--- a/offapi/com/sun/star/media/Manager.idl
+++ b/offapi/com/sun/star/media/Manager.idl
@@ -23,7 +23,7 @@
module com { module sun { module star { module media {
-/** a
The RDF data model
describes graphs of statements.
- The nodes in the graph are of type
The main part of the RDF data model is the
-
Documents that support metadata implement the interfaces
-
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
These services are needed for the insertByName
and replaceByName
methods of this service
-
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
The following services are available at the
-
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Presentation shapes can be used in a presentation
page layouts and their position and size is by default set
- by the presentation shapes on the
Instantiating this service, you can use its
-
Other components can register as
Other components can register as com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.
Whenever the
Usually, controls acting for an ImageControl model are consumers, and use the
data stream to display the image
If this property is present, it supersedes the
The value of this property is one of the
The value of this property is one of the com::sun::star::awt::ImageScaleMode constants.
@since OOo 3.2 */ diff --git a/offapi/com/sun/star/report/XReportControlFormat.idl b/offapi/com/sun/star/report/XReportControlFormat.idl index 95fe4b288c5f..d6b93fd738b7 100644 --- a/offapi/com/sun/star/report/XReportControlFormat.idl +++ b/offapi/com/sun/star/report/XReportControlFormat.idl @@ -85,7 +85,7 @@ interface XReportControlFormat }; - /** specifies theA DefaultComponentInspectorModel provides the following handlers by default:
A locale is deemed equal to another locale with identical diff --git a/offapi/com/sun/star/resource/XResourceBundle.idl b/offapi/com/sun/star/resource/XResourceBundle.idl index fa50b6d1ecfa..beb8ef911be1 100644 --- a/offapi/com/sun/star/resource/XResourceBundle.idl +++ b/offapi/com/sun/star/resource/XResourceBundle.idl @@ -160,7 +160,7 @@ module com { module sun { module star { module resource {
The get methods all require the key as an argument and return
the object if found. If the object is not found, the get methods
- throw a
NOTE: You should always supply a base service
with no suffixes. This will be the class of "last resort" if a
diff --git a/offapi/com/sun/star/resource/XStringResourceManager.idl b/offapi/com/sun/star/resource/XStringResourceManager.idl
index ad9a8f39062f..f4fccf7c2c94 100644
--- a/offapi/com/sun/star/resource/XStringResourceManager.idl
+++ b/offapi/com/sun/star/resource/XStringResourceManager.idl
@@ -35,7 +35,7 @@ module com { module sun { module star { module resource {
strings for different locales.
The interface is derived from
-
If false: If the exact locale that should be set is not available
- a
If false: If the exact locale that should be set is not available
- a
XStringResourceManager::setLocale
method.
@@ -84,7 +84,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster
@return the localized string for the specified ID and Locale
- @throws Document
does not denote a valid
- Document
does not denote a valid
- A persistent library container is associated with a root storage. The
container is responsible for a particular sub storage of the root storage,
diff --git a/offapi/com/sun/star/script/browse/XBrowseNode.idl b/offapi/com/sun/star/script/browse/XBrowseNode.idl
index ceba8b1d82d3..9d3d87e1adbf 100644
--- a/offapi/com/sun/star/script/browse/XBrowseNode.idl
+++ b/offapi/com/sun/star/script/browse/XBrowseNode.idl
@@ -45,7 +45,7 @@ interface XBrowseNode : ::com::sun::star::uno::XInterface
Get the children of this node
@returns
-
The proper value can be determined by using the
-
diff --git a/offapi/com/sun/star/sdb/Connection.idl b/offapi/com/sun/star/sdb/Connection.idl
index e3b5407b991f..e4232d28b2a3 100644
--- a/offapi/com/sun/star/sdb/Connection.idl
+++ b/offapi/com/sun/star/sdb/Connection.idl
@@ -38,7 +38,7 @@ module com { module sun { module star { module lang {
module application { interface XTableUIProvider; };
/** extends the
-
Usually, you don't deal with this loader directly. Instead, use an instance with
- the
This object is guaranteed to be a
This object is guaranteed to be a com::sun::star::sdbc::Connection, but usually
it will be a Connection from the module com::sun::star::sdb.
Especially in the case where no
The object will at least support the
The object will at least support the com::sun::star::sdbc::ResultSet service.
-Note that any superservices of
Note that any superservices of com::sun::star::sdbc::ResultSet
are also allowed. Especially, this member can denote an instance of the
-
If the elements specify bookmarks, and a
The object will at least support the
The object will at least support the com::sun::star::sdbcx::Column service, but more often it will even be a Column from the com::sun::star::sdb module.
*/ [optional, property] com::sun::star::beans::XPropertySet Column; diff --git a/offapi/com/sun/star/sdb/DataSettings.idl b/offapi/com/sun/star/sdb/DataSettings.idl index 04d25b8a8ddd..950e4e4c7c6b 100644 --- a/offapi/com/sun/star/sdb/DataSettings.idl +++ b/offapi/com/sun/star/sdb/DataSettings.idl @@ -28,7 +28,7 @@ /** extends the -Instead, the values in this property have two use cases:
You should use the
The object represented by this property supports the
The object represented by this property supports the com::sun::star::beans::PropertyBag service. That is, you can at runtime add arbitrary new properties to the bag.
Additionally, the property bag supports default values of properties, and thus the
-
Parameters (passed to the method Name
member
+ have to be instances of com::sun::star::beans::PropertyValue, or
+ instances of com::sun::star::beans::NamedValue, where the Name
member
specifies what the parameter controls, with the Value
member containing the value to be used.
Recognized parameters are:
The selection supplied by
Implements the service
-
Usually, you will not instantiate this service directly. Instead, you'll instantiate a generic
-
By default, the DatabaseInteractionHandler
feels responsible (as per configuration) for the
following interaction types:
SQLException
(or an instance of any derived class),
the handler will display a generic error dialog, which is able to travel the object chain which may be contained
in the exception.
You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
method of your
-
You specify a parameter by passing one (or more)
-
Imagine the initialization values as if you use setPropertyValue of the
-
allowed parameters are
@@ -85,7 +85,7 @@ published service DatasourceAdministrationDialog
If not specified, a default title is used.
The following commands are commonly supported by the
The following commands are commonly supported by the com::sun::star::ucb::XCommandProcessor
implementation of a DefinitionContent
:
The embedded documents do not support any particular database related service, instead, they're
- usual
+ usual com::sun::star::document::OfficeDocuments.
The only thing worth mentioning here is that they support the
-
DocumentDefinition
supports at least the following commands, additionally to
the ones already supported by the DefinitionContent:
Usual instances of a DocumentDefinition
are forms and reports.
Note that the DocumentDefinition
does not denote the actual document
- (i.e. an object supporting the
execute
method is the model of the loaded document.
You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
method of your
-
You specify a parameter by passing one (or more)
-
@@ -76,7 +76,7 @@ published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableD
allowed parameters are
@@ -85,14 +85,14 @@ published service ErrorMessageDialog : com::sun::star::ui::dialogs::XExecutableD
String describing the initial title of the dialog. If not specified, a default title is used.
Note that a database document actually does not support the
Note that a database document actually does not support the com::sun::star::view::XPrintable interface. + The non-optional requirement of this interface in the com::sun::star::document::OfficeDocument service is considered a documentation error.
*/ service com::sun::star::document::OfficeDocument; @@ -213,7 +213,7 @@ service OfficeDatabaseDocument need, they invokeSince this can be done by multiple clients, every client is additionally required
- to register itself as
In View Mode
, the designer is used to modify an existing or create a new server-side
view.
The view which is being designed must support the
The view which is being designed must support the com::sun::star::sdbcx::XAlterView
interface, except when a new view is being designed. In the latter case, the designer closes itself
automatically when XAlterView
is not supported, and the view has been saved.
Initialization is done using the
Initialization is done using the com::sun::star::lang::XInitialization interface, + which expects a sequence of objects being either com::sun::star::beans::NamedValues or + com::sun::star::beans::PropertyValues. The following parameters are supported at initialization time:
Parameters (passed to the method
Recognized parameters are:
Depending on the
-
next
, first
, last
, absolute
,
+ next
, first
, last
, absolute
,
relative
, previous
, beforeFirst
, afterLast
getFoo
getFoo
updateFoo
updateFoo
If you want a row set to be based on a parametrized query, you will usually use
- the
+ the com::sun::star::sdbc::XParameters interface.
However, you can also choose to let an interaction handler supply such data. For this, you may
for instance instantiate an InteractionHandler, which asks the user for the
data, or you may write your own one, which supplies the data from somewhere else.
- The default implementation will only ask for parameters which aren't set before through the
The support of this interface implies a semantical extension to the
The support of this interface implies a semantical extension to the com::sun::star::sdbc::XResultSetUpdate + interface which is supported via the com::sun::star::sdbc::ResultSet.
@see XResultSetUpdate */ @@ -218,7 +218,7 @@ published service RowSet /** is the interface for updating row data to the database. -The optional support of this interface is already implied with the support of the
The optional support of this interface is already implied with the support of the com::sun::star::sdbc::ResultSet service.
However, note that the additional support of the XRowSetApproveBroadcaster interface results
in a semantical extension: the methods
The optional support of this interface is already implied with the support of the
The optional support of this interface is already implied with the support of the com::sun::star::sdbcx::ResultSet service.
However, note that the additional support of the XRowSetApproveBroadcaster interface results
in a semantical extension: the method XParametersSupplier
interface.
The returned container contains parameter objects which do allow write access to the parameters (which
- is equivalent to using the
It hides the complexity of parsing and evaluating a single select statement and provides
sophisticated methods for expanding a statement with filter, group by, having and order
- criteria. To get the new extended statement use the methods from
A SingleSelectQueryComposer is usually obtained from a Connection
- using the
Parameters (passed to the method
Recognized parameters are:
@@ -52,7 +52,7 @@ published interface XCommandPreparation: com::sun::star::uno::XInterface
the command to be prepared. Any SQL statement.
@param commandType
kind of the command
-
Additionally, if the caller does long-lasting processing on the document, it's advised
- to add itself as
This continuation is typically used in conjunction with a
-
This continuation is typically used in conjunction with a
-
Usually, this contains an instance of
Usually, this contains an instance of com::sun::star::sdbc::SQLException.
*/ any Error; }; diff --git a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl index 52a6f4d4e43f..03c07a7bec9f 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl @@ -92,7 +92,7 @@ service CopyTableWizard : XCopyTableWizard then this connection will be disposed upon disposal of the wizard. @param Source - theThe following members of the DataAccessDescriptor
are supported, and evaluated
@@ -116,8 +116,8 @@ service CopyTableWizard : XCopyTableWizard
ConnectionResource
, or an
- ActiveConnection
which implements an ActiveConnection
which implements an com::sun::star::sdbc::Connection only
+ (as opposed to a com::sun::star::sdb::Connection), then the resulting connection is
not able to provide queries, thus a command type QUERY
will be rejected.Filter
, Order
, HavingClause
and GroupBy
@@ -126,7 +126,7 @@ service CopyTableWizard : XCopyTableWizard
Violating any of the above restrictions will result in an error at creation time.
@param Destination
- the Only DataSourceName
, DatabaseLocation
, ActiveConnection
@@ -134,7 +134,7 @@ service CopyTableWizard : XCopyTableWizard
in the order mentioned here, so if multiple of the are present, only the first one is evaluated.
Also, at the moment the connection which is implied by either of the settings above
- must support the
Note that creating a view (see DataSourceName
member.
@see ::com::sun::star::sdb::DataAccessDescriptor
@@ -182,8 +182,8 @@ service CopyTableWizard : XCopyTableWizard
specifies an interaction handler to use when user input is required.
When specifying this parameter, you should use an implementation
- supporting the
Note that reading this attribute is equivalent to querying the component
- for the
The components here might either be documents (
The components here might either be documents (com::sun::star::frame::XModel), + controllers (com::sun::star::frame::XController), or frames + (com::sun::star::frame::XFrame). @since OOo 3.0 */ @@ -161,8 +161,8 @@ interface XDatabaseDocumentUI it allows opening a table, query, form, or report for either editing or viewing.
This method is a convenience wrapper for API which is also available otherwise. For instance,
- for loading forms and reports, you could use the
Note there must exist a connection to the database before you can call this method.
@@ -195,17 +195,17 @@ interface XDatabaseDocumentUIHidden
flag (set to Most of the functionality provided here is meaningful only relative to
a given database connection. For instance, for quoting table names, you need
the meta data instance of the connection. Thus, the entry point for obtaining
a XConnectionTools instance is the
-
Note that nearly all functionality provided by this interface is also available by other means, it's only provided here for convenience purposes.
@@ -77,9 +77,9 @@ interface XConnectionTools /** get fields for a result set given by a "command descriptor"A command descriptor here means: -
All of the functionality present in this interface depends on a connection,
- thus it entry point for obtaining it is a
The component itself does not have life-time control mechanisms, i.e. you
cannot explicitly dispose it (
However, if your try to access any of its methods or attributes, after the
- connection which was used to create it was closed, a
Retrieving this attribute is equivalent to obtaining the tables
- container from the connection (via
In addition to the information provided by
- BatchUpdateException
provides the update counts for all commands
diff --git a/offapi/com/sun/star/sdbc/BestRowScope.idl b/offapi/com/sun/star/sdbc/BestRowScope.idl
index 0542e21bcd7e..bad4eeb3c4bf 100644
--- a/offapi/com/sun/star/sdbc/BestRowScope.idl
+++ b/offapi/com/sun/star/sdbc/BestRowScope.idl
@@ -32,7 +32,7 @@ published constants BestRowScope
A possible value for the column
SCOPE
in the
- SCOPE
in the
- SCOPE
in the
- PSEUDO_COLUMN
in the
- PSEUDO_COLUMN
in the
- PSEUDO_COLUMN
in the
-
IN parameter values are set using the set methods inherited from
- get
methods
provided by the
-
A
CallableStatement
can return one
- ResultSet
objects are
handled using operations inherited from
-
For maximum portability, a call's
- SEARCHABLE
in the
- SEARCHABLE
in the
- SEARCHABLE
in the
- SEARCHABLE
in the
- PSEUDO_COLUMN
in the
- PSEUDO_COLUMN
in the
- PSEUDO_COLUMN
in the
- TYPE
in the
- TYPE
in the
- TYPE
in the
- TYPE
in the
-
The class path is a list of zero or more internal (see the
- U+0020
) are ignored (and, in particular, separate adjacent
URI references). Any “vnd.sun.star.expand” URL references
in the list are expanded using the
-
DELETE_RULE
in the
- DELETE_RULE
in the
- DELETE_RULE
in the
- DELETE_RULE
in the
- DELETE_RULE
in the
-
Only one
- COLUMN_TYPE
in the
- COLUMN_TYPE
in the
- COLUMN_TYPE
in the
- COLUMN_TYPE
in the
- COLUMN_TYPE
in the
- COLUMN_TYPE
in the
- PROCEDURE_TYPE
in the
- PROCEDURE_TYPE
in the
- PROCEDURE_TYPE
in the
-
If this Statement
object has not set a fetch direction,
@@ -215,11 +215,11 @@ published service ResultSet
/** retrieves the number of result set rows that is the default fetch size
for result sets generated from this
-
If this
-
@@ -109,7 +109,7 @@ published service RowSet
/** retrieves the number of seconds the driver will wait for a Statement
to execute. If the limit is exceeded, a
-
Each
-
Methods in the interfaces
- getBlob
and
diff --git a/offapi/com/sun/star/sdbc/XClob.idl b/offapi/com/sun/star/sdbc/XClob.idl
index 83fefac33b4d..9f8cac3b8e76 100644
--- a/offapi/com/sun/star/sdbc/XClob.idl
+++ b/offapi/com/sun/star/sdbc/XClob.idl
@@ -74,10 +74,10 @@
Methods in the interfaces
- getClob
and
diff --git a/offapi/com/sun/star/sdbc/XConnection.idl b/offapi/com/sun/star/sdbc/XConnection.idl
index 90a3c6f11975..9b2f24af4b2d 100644
--- a/offapi/com/sun/star/sdbc/XConnection.idl
+++ b/offapi/com/sun/star/sdbc/XConnection.idl
@@ -58,7 +58,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable
{
/** creates a new
-
@@ -85,7 +85,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable
XStatement createStatement() raises (SQLException);
/** creates a
-
The constants defined in
-
diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl index 9c298e0b16fb..dbfef368b080 100644 --- a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl @@ -34,17 +34,17 @@
Many of the methods here return lists of information in
the form of
-
A
- XResultSet.rowUpdated
.
@param setType
defined in
-
The driver should raise a
-
For a user-named parameter the fully-qualified SQL type name of the
diff --git a/offapi/com/sun/star/sdbc/XParameters.idl b/offapi/com/sun/star/sdbc/XParameters.idl
index 8e0b1156656a..1448220cd497 100644
--- a/offapi/com/sun/star/sdbc/XParameters.idl
+++ b/offapi/com/sun/star/sdbc/XParameters.idl
@@ -257,7 +257,7 @@ published interface XParameters: com::sun::star::uno::XInterface
the specified number of bytes.
When a very large binary value is input to a LONGVARBINARY or LONGVARCHAR
parameter, it may be more practical to send it via an
-
A
-
In addition, SQL statements that return nothing, such as
@@ -80,10 +80,10 @@ published interface XPreparedStatement: com::sun::star::uno::XInterface
boolean execute() raises (SQLException);
/** returns the
-
The number, types, and properties of a ResultSet's columns are
provided by the
-
When an object of a class implementing interface
- XSQLOutput.writeXXX
methods to write data from the
- XSQLOutput
output stream as the representation of a SQL user-defined type.
XSQLOutput
output stream in the same order in which they were
diff --git a/offapi/com/sun/star/sdbc/XStatement.idl b/offapi/com/sun/star/sdbc/XStatement.idl
index 2052a566e794..28ddddb0780a 100644
--- a/offapi/com/sun/star/sdbc/XStatement.idl
+++ b/offapi/com/sun/star/sdbc/XStatement.idl
@@ -79,7 +79,7 @@ published interface XStatement: com::sun::star::uno::XInterface
this unless you are (1) executing a stored procedure that you know may
return multiple results or (2) you are dynamically executing an
unknown SQL string. The navigation through multiple results is covered by
-
The
@@ -104,7 +104,7 @@ published interface XStatement: com::sun::star::uno::XInterface
boolean execute([in]string sql) raises (SQLException);
/** returns the
- Statement
diff --git a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl
index 459dc17fad9e..d3c5bc88b15b 100644
--- a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl
+++ b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl
@@ -38,7 +38,7 @@ published interface XWarningsSupplier: com::sun::star::uno::XInterface
Note: Subsequent warnings will be chained to this
-
This service is optional for each driver. Its purpose is to define
diff --git a/offapi/com/sun/star/sdbcx/PreparedStatement.idl b/offapi/com/sun/star/sdbcx/PreparedStatement.idl
index cbd8f1c2e4e1..3fe7b639bf01 100644
--- a/offapi/com/sun/star/sdbcx/PreparedStatement.idl
+++ b/offapi/com/sun/star/sdbcx/PreparedStatement.idl
@@ -25,7 +25,7 @@ module com { module sun { module star { module sdbcx {
/**
extends the definition of the service
-
The
The com::sun::star::container::XNameContainer + and com::sun::star::container::XNameReplace interfaces can be used to manage the members that this group contains. It is possible to insert, remove, and replace members.
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl index a673ddd2c127..f649f38a93ff 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl @@ -62,8 +62,8 @@ published service DataPilotFieldGroups /** provides read/write access to the data pilot field groups in the collection via name. -The
The com::sun::star::container::XNameContainer + and com::sun::star::container::XNameReplace interfaces can be used to manage the item groups. It is possible to insert, remove, and replace item groups.
diff --git a/offapi/com/sun/star/sheet/ExternalReference.idl b/offapi/com/sun/star/sheet/ExternalReference.idl index ac31c8f87fdc..70f4e1d9fc83 100644 --- a/offapi/com/sun/star/sheet/ExternalReference.idl +++ b/offapi/com/sun/star/sheet/ExternalReference.idl @@ -38,8 +38,8 @@ struct ExternalReference has a unique index value.You can get the index value of an external document from the
- corresponding
This cached data is used for external cell and cell range references,
- as well as external range names. An
All container access methods return a sequence of
-
This service extends the
This service extends the com::sun::star::table::TableSortDescriptor service with spreadsheet specific properties.
*/ published service SheetSortDescriptor diff --git a/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl b/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl index 5213d1e78fed..a70d96189cbe 100644 --- a/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl +++ b/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module sheet { /** a description of how a cell range is to be sorted. -This service extends the
This service extends the com::sun::star::table::TableSortDescriptor2 service with spreadsheet specific properties.
@since OOo 1.1.2 diff --git a/offapi/com/sun/star/sheet/SolverConstraint.idl b/offapi/com/sun/star/sheet/SolverConstraint.idl index c8f9cf5b184b..1171247e87c4 100644 --- a/offapi/com/sun/star/sheet/SolverConstraint.idl +++ b/offapi/com/sun/star/sheet/SolverConstraint.idl @@ -38,7 +38,7 @@ struct SolverConstraint SolverConstraintOperator Operator; /** The comparison value, of typeThis interface is derived from
-
It also lets you add new
It also lets you add new com::sun::star::drawing::Shapes. The program currently
+ requires that these com::sun::star::drawing::Shapes be created by the factory of
the document.
@see SpreadsheetDocument
@@ -61,7 +61,7 @@ published service SpreadsheetDrawPage
/** With this interface you can group/ungroup a collection of
-
The selection in a spreadsheet view can be a
-
This service extends the service
-
This service extends the service
-
The
The com::sun::star::table::CellAddress can be used to address the cell within its document.
*/ com::sun::star::table::CellAddress getCellAddress(); diff --git a/offapi/com/sun/star/sheet/XCellRangeAddressable.idl b/offapi/com/sun/star/sheet/XCellRangeAddressable.idl index 03375e68cf4c..973c69d73da4 100644 --- a/offapi/com/sun/star/sheet/XCellRangeAddressable.idl +++ b/offapi/com/sun/star/sheet/XCellRangeAddressable.idl @@ -28,14 +28,14 @@ module com { module sun { module star { module sheet { /** represents a cell which can be addressed with a -The
The com::sun::star::table::CellRangeAddress can be used to address the range within its document.
*/ com::sun::star::table::CellRangeAddress getRangeAddress(); diff --git a/offapi/com/sun/star/sheet/XCellRangeData.idl b/offapi/com/sun/star/sheet/XCellRangeData.idl index 3f4318e2e91d..79a420739cd8 100644 --- a/offapi/com/sun/star/sheet/XCellRangeData.idl +++ b/offapi/com/sun/star/sheet/XCellRangeData.idl @@ -44,7 +44,7 @@ published interface XCellRangeData: com::sun::star::uno::XInterface range. Each element of the array must contain aThis interface extends the interface
-
This method returns a different output range of a DataPilot table per specified output range type.
- @returnsThis interface extends the interface
-
This index value corresponds with the external document
represented by an instance of
-
Each external document cache instance has a unique index value, and this
index value can be used to retrieve the corresponding external document cache
- from the parent
The container access methods return a sequence of
-
The specified range must fit exactly to an element of the collection. The method does not try to shorten a range.
- @throwsAll specified ranges must fit exactly to elements of the collection. The method does not try to shorten ranges.
- @throwsIt is normally represented by a sequence of
-
This
This com::sun::star::container::XNameContainer
supports the service
-
com::sun::star::text::HorizontalAdjusts.
*/ [optional,property] short FootnoteLineAdjust; /** contains the distance between the text and the separator line between the @@ -334,7 +334,7 @@ of the current page is used as limit. scope="com::sun::star::text">WritingMode2 constants */ [optional,property] short WritingMode; /** contains the mode of the text grid (none, lines, ...), as - represented byThe proper value can be determined by using the
-
The arguments passed to the
The following aspects of the components can be initialized:
Note that this interface is already optionally allowed in the
- underlying service (
The arguments passed to the
The following aspects of the components can be initialized:
It extends the general
-
The continuation restrictions are as follows: Let C be the
subset of the provided continuations that are of type
-
An
-
"Uri"
- A possible factory is the
All of these properties are either already available in the
service
-
In the
In the com::sun::star::style::NumberingAlignment only the field
For the interaction of this property with other data access relevant properties, see
- the
For the interaction of this property with other data access relevant properties, see
- the
For the interaction of this property with other data access relevant properties, see
- the
Note that any superservices of
Note that any superservices of com::sun::star::sdbc::ResultSet
are also allowed. Especially, this member can denote an instance of the
-
For the interaction of this property with other data access relevant properties, see
- the
For the interaction of this property with other data access relevant properties, see
- the
This property is relevant in conjunction with the
Note that this implies that the
If this array is empty, the whole result set, as described by
For the interaction of this property with other data access relevant properties, see
- the
For the interaction of this property with other data access relevant properties, see
- the
For the interaction of this property with other data access relevant properties, see
- the
There are two different ways to get newly created shapes into the
text document. One of them is to use the insertTextContent() method of
- the
If the concrete TextContent has a "floating" object,
- like a graphic,
This service extends the service
-
A TextRange is also used for a text portion which is
- returned by the
FootnoteIsOwnNumbering
is set.
*/
[property] short FootnoteNumberingType;
@@ -160,7 +160,7 @@ published service TextSection
*/
[property] boolean EndnoteIsOwnNumbering;
/** determines the numbering type of the endnote numbering as a value of
- EndoteIsOwnNumbering
is set.
*/
[property] short EndnoteNumberingType;
diff --git a/offapi/com/sun/star/text/TextSortable.idl b/offapi/com/sun/star/text/TextSortable.idl
index 731faa7c1bd4..c1b7afb1d9a4 100644
--- a/offapi/com/sun/star/text/TextSortable.idl
+++ b/offapi/com/sun/star/text/TextSortable.idl
@@ -40,7 +40,7 @@ published service TextSortable
of this interfaces implementation are those of the
"com.sun.star.text.TextSortDescriptor" service.
- @see Uses values
Uses values com::sun::star::awt::FieldUnit
@since OOo 3.1 */ [optional, property] long HorizontalRulerMetric; /** metric unit of the vertical ruler -Uses values from
Uses values from com::sun::star::awt::FieldUnit
@since OOo 3.1 */ diff --git a/offapi/com/sun/star/text/XChapterNumberingSupplier.idl b/offapi/com/sun/star/text/XChapterNumberingSupplier.idl index d050098183ef..c7788bcdeff5 100644 --- a/offapi/com/sun/star/text/XChapterNumberingSupplier.idl +++ b/offapi/com/sun/star/text/XChapterNumberingSupplier.idl @@ -36,7 +36,7 @@ published interface XChapterNumberingSupplier: com::sun::star::uno::XInterface the collection of numbering rules for this document.This interface allows access to the properties
- of the numbering level via a sequence of
Outline numberings usually consist of levels with different settings.
- @seeIn contrast to outline numberings the continuous numberings consist of level using the equal settings in all numbering levels.
- @seeUse
Use com::sun::star::util::XRefreshable and + com::sun::star::lang::XServiceInfo instead, if available.
diff --git a/offapi/com/sun/star/text/XMailMergeBroadcaster.idl b/offapi/com/sun/star/text/XMailMergeBroadcaster.idl index 02d4870f7150..2e00e2034a04 100644 --- a/offapi/com/sun/star/text/XMailMergeBroadcaster.idl +++ b/offapi/com/sun/star/text/XMailMergeBroadcaster.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module text { /** allows for adding/removing of mail merge event listeners.Registered listeners will be notified with a
-
Registered listeners will be notified with a
-
To be able to store unknown numbering types in a file format the numbering types correspond to an identifier.
- @seeThis text does not contain texts in TextFrames,
or cells of TextTables etc. directly. These are
diff --git a/offapi/com/sun/star/text/XTextShapesSupplier.idl b/offapi/com/sun/star/text/XTextShapesSupplier.idl
index e86da0567e4c..0994dd107229 100644
--- a/offapi/com/sun/star/text/XTextShapesSupplier.idl
+++ b/offapi/com/sun/star/text/XTextShapesSupplier.idl
@@ -27,7 +27,7 @@
module com { module sun { module star { module text {
-/** provides the collection of
[property] boolean IsSortAscending;
Determines whether the sorting is ascending or descending.
- It uses the type
The value can be one of the
-
The default value is implementation specific. diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 3dde01a11d7b..5f5a57e5386a 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -38,7 +38,7 @@ published service CachedDynamicResultSet /** Provides remote optimized read access to a static or a dynamically changing ContentResultSet. -
The
The com::sun::star::sdbc::XResultSets given to the listener in the first notification in the WelcomeDynamicResultSetStruct are implementations of the CachedContentResultSet service. diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index b7aaef24de28..80c7fcd06f82 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -39,7 +39,7 @@ published service CachedDynamicResultSetStub remote optimized read access to a static or dynamically changing ContentResultSet. -
The
The com::sun::star::sdbc::XResultSets given to
the listener in the first notification in the
WelcomeDynamicResultSetStruct are implementations of
CachedContentResultSetStub.
diff --git a/offapi/com/sun/star/ucb/CommandEnvironment.idl b/offapi/com/sun/star/ucb/CommandEnvironment.idl
index bfaeba914132..55130cb68412 100644
--- a/offapi/com/sun/star/ucb/CommandEnvironment.idl
+++ b/offapi/com/sun/star/ucb/CommandEnvironment.idl
@@ -28,8 +28,8 @@ module com { module sun { module star { module ucb {
/* This service implements an XCommandEnvironment that can be
initialized with any implementation of
-
If a property with an unsupported type shall be added a
-
This interface must be implemented, if the implementation can
dynamically change it's property set ( e.g. because it implements
the interface
-
This interface is required. @@ -62,7 +62,7 @@ published service ContentResultSet
Note that every method of this interface implementation additionally
may throw a ResultSetException ( which is derived from
-
Note that every method of this interface implementation additionally
may throw a ResultSetException ( which is derived from
-
Note that every method of this interface implementation additionally
may throw a ResultSetException ( which is derived from
-
A client can register an
-
An implementation should collect as many changes as possible into a
- single
With both of the standard service specifiers above, an implementation diff --git a/offapi/com/sun/star/ucb/IOErrorCode.idl b/offapi/com/sun/star/ucb/IOErrorCode.idl index 92a986f4996c..d92d8c6961bc 100644 --- a/offapi/com/sun/star/ucb/IOErrorCode.idl +++ b/offapi/com/sun/star/ucb/IOErrorCode.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** Types of input/output errors. -
See
See com::sun::star::task::InteractionHandler for a description of what kinds of arguments InteractiveAugmentedIOException should use with each of these error codes.
diff --git a/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl b/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl index 32702ff880d9..723195643dfb 100644 --- a/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl +++ b/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl @@ -31,7 +31,7 @@ published exception InteractiveAugmentedIOException : com::sun::star::ucb::Inter { /** Additional arguments. -See
See com::sun::star::task::InteractionHandler for a description of well-known arguments.
*/ sequence< any > Arguments; diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl index e4930ea8303b..6b41b3507f32 100644 --- a/offapi/com/sun/star/ucb/ListAction.idl +++ b/offapi/com/sun/star/ucb/ListAction.idl @@ -35,9 +35,9 @@ published struct ListAction1
as usual with JDBC ).
Its value does not necessary indicate the new position in the new
-
The member
The members
This action is related to a
This action is related to a com::sun::star::beans::PropertyChangeEvent.
The members
For example, the command "insert" may fail, if the implementation expects that an input stream is supplied with the given diff --git a/offapi/com/sun/star/ucb/NameClashResolveRequest.idl b/offapi/com/sun/star/ucb/NameClashResolveRequest.idl index 79e105fcdbc2..b5374fd42884 100644 --- a/offapi/com/sun/star/ucb/NameClashResolveRequest.idl +++ b/offapi/com/sun/star/ucb/NameClashResolveRequest.idl @@ -32,10 +32,10 @@ module com { module sun { module star { module ucb { target folder that has the same file name as the source file.
If this exception is passed to an
-
XActiveDataSink and XOutputStream give the caller read-only access to the contents. XActiveDataStreamer offers both read and @@ -53,9 +53,9 @@ published struct OpenCommandArgument
If an XActiveDataSink is supplied, the implementation of the command
needs to provide an implementation of an object implementing the
- interface
Traditionally, this service implements
-
(For backwards compatibility, the service implementation still supports
-
@@ -96,7 +96,7 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent
/** Call this, if you don't care about any changes.
@returns
- an
In the first notify-call the listener gets two(!)
-
The notified new
-
The Uno Url is handed to the
-
A default interaction handler is available as service
-
Hopefully you will only use this, when Source
- is an
- An implementation must provide a
A module user interface configuration manager instance needs the following arguments as
-
- An implementation must provide a
An implementation is usually obtained from a
-
The container contains the items of the user interface element. Every
- item is stored as a sequence of
To access the window based information of a module, a unique module specifier
must be provided to
- The
The callee must size its document window so that we have the amount
- of space we have provided. The
If a command URL cannot be found the replace call will be omitted. If
aCommandURLSequence contains an invalid command URL a
-
If the aCommandURLSequence contains an invalid command URL a
-
If an association is already present it is replaced. If
aCommandURLSequence contains an invalid command URL a
-
The following
-
If the settings data cannot be found a
-
If the settings data cannot be found a
-
If the settings data is already present a
-
The type of the interface depends on the real type of the user interface
element. A menubar user interface element provides access to its
-
Using this function can be very dangerous as other implementation with OpenOffice may not be able to create their
diff --git a/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl
index f3bce8d7db52..f96221f7dbf5 100644
--- a/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl
+++ b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl
@@ -24,7 +24,7 @@
module com { module sun { module star { module ui { module dialogs {
/** These constants are used to specify image formats supported by an implementation
- of the interface
The user options are stored inside the
The user options are stored inside the com::sun::star::document::MediaDescriptor + and can be queried from the com::sun::star::document::MediaDescriptor by + the component that implements com::sun::star::document::XFilter.
-The application will set the
The application will set the com::sun::star::document::MediaDescriptor
+ using the interface com::sun::star::beans::XPropertyAccess and then
call
If that method returns ExecutableDialogResults::OK
,
- the application will retrieve the changed
Otherwise, the filter operation is canceled.
@@ -49,8 +49,8 @@ module com { module sun { module star { module ui { module dialogs { published service FilterOptionsDialog { /** this interface is used to set the property values of the -
If this method was already called on an object it should return without any reaction. Normally it's possible to throw
- a
The method iterates through it's internal variable list and tries to
find the given variable. If the variable is unknown a
-
A form controller is a component which controls the user interaction @@ -65,7 +65,7 @@ interface XFormLayerAccess
Note: This is a convenience method. In the user interface,
the design mode is coupled with the .uno:SwitchControlDesignMode
- feature (see
Note: This is a convenience method. In the user interface,
the design mode is coupled with the .uno:SwitchControlDesignMode
- feature (see
This interface is an optional part of the
-
The elements of the repository are instances supporting the
The elements of the repository are instances supporting the com::sun::star::xsd::XDataType interface.
*/ interface XDataTypeRepository diff --git a/offapi/com/sun/star/xforms/XModel.idl b/offapi/com/sun/star/xforms/XModel.idl index b351e4f539fe..878c89043b97 100644 --- a/offapi/com/sun/star/xforms/XModel.idl +++ b/offapi/com/sun/star/xforms/XModel.idl @@ -116,7 +116,7 @@ interface XModel /** gets container containing all instances; -The elements of the set are arrays of
The elements of the set are arrays of com::sun::star::beans::PropertyValues, containing the ID, the URL, and the instance itself.
*/ com::sun::star::container::XSet getInstances(); diff --git a/offapi/com/sun/star/xml/ExportFilter.idl b/offapi/com/sun/star/xml/ExportFilter.idl index 919325b17594..8d078ed3244b 100644 --- a/offapi/com/sun/star/xml/ExportFilter.idl +++ b/offapi/com/sun/star/xml/ExportFilter.idl @@ -31,21 +31,21 @@ module com { module sun { module star { module xml { called to provide the export component with the target location to which the data should be exported. Then, the source document's XML representation will be generated by calling the appropriate methods - of theThe
-
The
-
The
-
It is an extension of
It is an extension of com::sun::star::document::ExportFilter
and differs from it only in that an
-
It is an extension of
It is an extension of com::sun::star::document::ImportFilter
and differs from it in that this filter additionally supports the
-
This interface describes a name-type-value triple which describes a
single attribute of a tag. Implementors are encouraged to implement the
-