Kaydet (Commit) f5badcaf authored tarafından Mikhail Voytenko's avatar Mikhail Voytenko

fwk138: #i87496# publish services, interfaces and etc.

üst bdf16899
......@@ -35,7 +35,7 @@ module com { module sun { module star { module embed {
/** This constant set contains possible actions that could be approved by
<type>ActionsApproval</type> implementation.
*/
constants Actions
published constants Actions
{
//------------------------------------------------------------------------
/** "Prevent Close" - throws veto excetion if target object is going to
......
......@@ -49,7 +49,7 @@ module com { module sun { module star { module embed {
@see XEmbeddedObject
*/
constants Aspects
published constants Aspects
{
// MS OLE aspects
......
......@@ -44,7 +44,7 @@
//============================================================================
/** This is a service that allows to get access to a storage hierarchy.
*/
service BaseStorage
published service BaseStorage
{
// -----------------------------------------------------------------------
/** This is a general interface representing storage functionality.
......
......@@ -65,7 +65,7 @@ module com { module sun { module star { module embed {
from the container system window.
</p>
*/
service DocumentCloser : com::sun::star::lang::XComponent
published service DocumentCloser : com::sun::star::lang::XComponent
{
/** is used to initialize the object on it's creation.
......
......@@ -43,7 +43,7 @@ module com { module sun { module star { module embed {
@see <type>XStorage</type>
*/
constants ElementModes
published constants ElementModes
{
//------------------------------------------------------------------------
/** specifies opening of an element for reading.
......
......@@ -37,7 +37,7 @@ module com { module sun { module star { module embed {
@see XVisualObject
*/
constants EmbedMapUnits
published constants EmbedMapUnits
{
// ----------------------------------------------------------------------
/** In this type of map mode one logical point is equal to one-hundredth
......
......@@ -47,7 +47,7 @@ module com { module sun { module star { module embed {
@see XEmbeddedObject
*/
constants EmbedMisc
published constants EmbedMisc
{
// analog of the MS OLEMISC enum
......
......@@ -36,7 +36,7 @@ module com { module sun { module star { module embed {
/** This constant set contains possible states for
<type>EmbeddedObject</type>.
*/
constants EmbedStates
published constants EmbedStates
{
//------------------------------------------------------------------------
/** "Loaded" - the persistent representation of the object is loaded in
......
......@@ -37,7 +37,7 @@ module com { module sun { module star { module embed {
@see XEmbeddedObject
*/
constants EmbedUpdateModes
published constants EmbedUpdateModes
{
// -----------------------------------------------------------------------
/** An object representation should be updated as often as possible.
......
......@@ -37,7 +37,7 @@ module com { module sun { module star { module embed {
@see XEmbeddedObject
*/
constants EmbedVerbs
published constants EmbedVerbs
{
//------------------------------------------------------------------------
/** lets the object do default activation, as by doubleclick.
......
......@@ -69,7 +69,7 @@ module com { module sun { module star { module embed {
@see com::sun::star::beans::PropertyValue
*/
service EmbeddedObjectDescriptor
published service EmbeddedObjectDescriptor
{
//------------------------------------------------------------------------
/** lets the graphical representation of embedded document be stored.
......
......@@ -38,7 +38,7 @@ module com { module sun { module star { module embed {
@see XEmbedPersist
*/
constants EntryInitModes
published constants EntryInitModes
{
// -----------------------------------------------------------------------
/** In case object persistance is created based on existing entry,
......
......@@ -40,7 +40,7 @@
/** This is a service that allows to get access to a file system folder using
storage hierarchy.
*/
service FileSystemStorage
published service FileSystemStorage
{
// -----------------------------------------------------------------------
/** This service describes the base functionality of storages.
......
......@@ -42,7 +42,7 @@
create a <type>FileSystemStorage</type> based on URL. The URL must point
to a folder.
*/
service FileSystemStorageFactory
published service FileSystemStorageFactory
{
// ----------------------------------------------------------------------
/** A storage can be created through this interface.
......
......@@ -43,7 +43,7 @@
/** is intended to provide result of creation of an embedded object by dialog.
*/
struct InsertedObjectInfo
published struct InsertedObjectInfo
{
//-------------------------------------------------------------------------
/** The new created embedded object.
......
......@@ -57,7 +57,7 @@ module com { module sun { module star { module embed {
the listener throw related veto exception until the service is disposed.
</p>
*/
service InstanceLocker : com::sun::star::lang::XComponent
published service InstanceLocker : com::sun::star::lang::XComponent
{
/** is used to initialize the object on it's creation.
......
......@@ -44,7 +44,7 @@
For example in case it is broken one.
</p>
*/
exception InvalidStorageException: com::sun::star::io::IOException
published exception InvalidStorageException: com::sun::star::io::IOException
{
};
......
......@@ -44,7 +44,7 @@
Or if embedded object is misused as a linked object.
</p>
*/
exception LinkageMisuseException: com::sun::star::uno::Exception
published exception LinkageMisuseException: com::sun::star::uno::Exception
{
};
......
......@@ -47,7 +47,7 @@
addition to the loaded state. Other states and possible verbs can be
detected only after object is switched to running state.
*/
exception NeedsRunningStateException: WrongStateException
published exception NeedsRunningStateException: WrongStateException
{
};
......
......@@ -41,7 +41,7 @@
/** This exception can be thrown in case the object can not provide own visual
area currently.
*/
exception NoVisualAreaSizeException: com::sun::star::uno::Exception
published exception NoVisualAreaSizeException: com::sun::star::uno::Exception
{
};
......
......@@ -45,7 +45,7 @@ module com { module sun { module star { module embed {
/** This service provides a simple functionality to allow
read/write the storages in OLE storage format.
*/
service OLESimpleStorage: XOLESimpleStorage
published service OLESimpleStorage: XOLESimpleStorage
{
// CONSTRUCTORS ----------------------------------------------------------
/** is used to initialize the object on it's creation.
......
......@@ -43,7 +43,7 @@
@see XEmbeddedClient
*/
exception ObjectSaveVetoException: com::sun::star::uno::Exception
published exception ObjectSaveVetoException: com::sun::star::uno::Exception
{
};
......
......@@ -42,7 +42,7 @@
to call requested functionality currently because the object is changing
state.
*/
exception StateChangeInProgressException: com::sun::star::embed::WrongStateException
published exception StateChangeInProgressException: com::sun::star::embed::WrongStateException
{
//------------------------------------------------------------------------
/** contains the target state the object tries to reach currently.
......
......@@ -75,7 +75,7 @@
of a parent storage.
</p>
*/
service Storage
published service Storage
{
// -----------------------------------------------------------------------
/** This service describes the base functionality of storages.
......
......@@ -41,7 +41,7 @@
/** The <type>StorageFactory</type> is a service that allows to create
a storage based on either stream or URL.
*/
service StorageFactory
published service StorageFactory
{
// ----------------------------------------------------------------------
/** A storage can be created through this interface.
......@@ -82,13 +82,22 @@ service StorageFactory
<dt>parameter 3</dt>
<dd>
allowes to provide
this paramenter represents
<type scope="com::sun::star::uno">Any</type>
containing a sequence of
<type scope="com::sun::star::beans">PropertyValue</type>.<br>
The parameter can contain entries from
<type scope="com::sun::star::document">MediaDescryptor</type>
to the storage so some parts can be used for
to transport some document info during the storage
initialization, it can be for example
<type scope="com::sun::star::task">XInteractionHandler</type>
implementation, password for the storage and repair
package flag.
package flag.<br>
Additionaly the parameter might contain property with the name
"StorageFormat" that can take values from
<type scope="com::sun::star::embed">StorageFormats</type>.
If the property is not provided a storage of package format
is created.
</dd>
</dl>
......
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_embed_StorageFormats_idl__
#define __com_sun_star_embed_StorageFormats_idl__
//============================================================================
module com { module sun { module star { module embed {
//============================================================================
/** The constant set contains IDs of formats that are supported by
<type>StorageFactory</type>.
@see <type>StorageFactory</type>
@since OOo 3.3
*/
published constants StorageFormats
{
//------------------------------------------------------------------------
/** specifies package format
*/
const long PACKAGE = 1;
//------------------------------------------------------------------------
/** specifies zip format
*/
const long ZIP = 2;
//------------------------------------------------------------------------
/** specifies Office Open XML format
*/
const long OFOPXML = 3;
};
//============================================================================
}; }; }; };
#endif
......@@ -64,7 +64,7 @@
of the stream can exist.
</p>
*/
service StorageStream
published service StorageStream
{
// -----------------------------------------------------------------------
/** allows to get access to <type scope="com::sun::star::io">XInputStream</type>
......
......@@ -41,7 +41,7 @@
/** This exception can wrap an exception thrown during <type>XStorage</type>
methods execution.
*/
exception StorageWrappedTargetException: com::sun::star::lang::WrappedTargetException
published exception StorageWrappedTargetException: com::sun::star::lang::WrappedTargetException
{
};
......
......@@ -40,7 +40,7 @@
/** This exception can be thrown in case specified state can not be reached.
*/
exception UnreachableStateException: com::sun::star::uno::Exception
published exception UnreachableStateException: com::sun::star::uno::Exception
{
// -----------------------------------------------------------------------
/** The current state of the object.
......
......@@ -51,7 +51,7 @@
internally, and can be used as a temporary storage usually used.
</p>
*/
exception UseBackupException: com::sun::star::io::IOException
published exception UseBackupException: com::sun::star::io::IOException
{
/** The URL of the temporary file the storage is based on now.
*/
......
......@@ -37,7 +37,7 @@ module com { module sun { module star { module embed {
@see VerbDescriptor
*/
constants VerbAttributes
published constants VerbAttributes
{
// -----------------------------------------------------------------------
/** Execution of the verb with this attribute must not modify the
......
......@@ -36,7 +36,7 @@
/** describes a verb.
*/
struct VerbDescriptor
published struct VerbDescriptor
{
//------------------------------------------------------------------------
/** specifies the id of the verb.
......
......@@ -39,7 +39,7 @@
/** can contain a graphical representation in an arbitrary format.
*/
struct VisualRepresentation
published struct VisualRepresentation
{
//-------------------------------------------------------------------------
/** The format of the visual representation.
......
......@@ -41,7 +41,7 @@
/** This exception can be thrown in case the object's state does not allow
to call requested functionality.
*/
exception WrongStateException: com::sun::star::uno::Exception
published exception WrongStateException: com::sun::star::uno::Exception
{
};
......
......@@ -44,7 +44,7 @@
possible actions must be documented in documentation of the object.
</p>
*/
interface XActionsApproval: com::sun::star::uno::XInterface
published interface XActionsApproval: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** requests an approval for the specified action.
......
......@@ -43,7 +43,7 @@
//============================================================================
/** represents common functionality for embedded objects
*/
interface XClassifiedObject: com::sun::star::uno::XInterface
published interface XClassifiedObject: com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** retrieves class ID of the object.
......
......@@ -59,7 +59,7 @@
/** specifies common implementation for embedded objects and links
persistence.
*/
interface XCommonEmbedPersist: com::sun::star::uno::XInterface
published interface XCommonEmbedPersist: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** lets the object or the link store itself.
......
......@@ -38,7 +38,7 @@
//=============================================================================
/** provides access to a component.
*/
interface XComponentSupplier: com::sun::star::uno::XInterface
published interface XComponentSupplier: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** allows to get access to a component.
......
......@@ -67,7 +67,7 @@
an embedded object based on system clipboard.
</p>
*/
interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterface
published interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** creates a new object and initializes it from the system clipboard.
......
......@@ -63,7 +63,7 @@
an embedded object.
</p>
*/
interface XEmbedObjectCreator: com::sun::star::uno::XInterface
published interface XEmbedObjectCreator: com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** creates a new object and initializes it as a new one.
......
......@@ -61,7 +61,7 @@
This interface provides user with full control over object creation.
</p>
*/
interface XEmbedObjectFactory: com::sun::star::uno::XInterface
published interface XEmbedObjectFactory: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** creates a new object and transport parameters for persistent
......
......@@ -67,7 +67,7 @@
representation.
</p>
*/
interface XEmbedPersist: XCommonEmbedPersist
published interface XEmbedPersist: XCommonEmbedPersist
{
//------------------------------------------------------------------------
/** provides object with a parent storage and a name for object's entry.
......
......@@ -52,7 +52,7 @@
//============================================================================
/** represents common functionality for embedded clients.
*/
interface XEmbeddedClient: XComponentSupplier
published interface XEmbeddedClient: XComponentSupplier
{
//------------------------------------------------------------------------
/** asks client to let the object store itself.
......
......@@ -92,7 +92,7 @@
//============================================================================
/** represents common functionality for embedded objects.
*/
interface XEmbeddedObject
published interface XEmbeddedObject
{
// INTERFACES
//
......
......@@ -42,7 +42,7 @@
//============================================================================
/** This interface allows to set a password for an object.
*/
interface XEncryptionProtectedSource: com::sun::star::uno::XInterface
published interface XEncryptionProtectedSource: com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** sets a password for the object.
......
......@@ -63,7 +63,7 @@
/** This interface allows access to an extended storage stream that might be
transacted.
*/
interface XExtendedStorageStream
published interface XExtendedStorageStream
{
// INTERFACES
//
......
......@@ -56,7 +56,7 @@
Thus the window can not resize/move itself.
</p>
*/
interface XHatchWindow: com::sun::star::lang::XComponent
published interface XHatchWindow: com::sun::star::lang::XComponent
{
//------------------------------------------------------------------------
/** sets the object that will control resizing/moving, if the object is
......
......@@ -49,7 +49,7 @@
rectangle size.
</p>
*/
interface XHatchWindowController: com::sun::star::uno::XInterface
published interface XHatchWindowController: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** requests window owner to resize/move the window.
......
......@@ -55,7 +55,7 @@
/** creates a hatch window implementation.
*/
interface XHatchWindowFactory: com::sun::star::uno::XInterface
published interface XHatchWindowFactory: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** creates a new hatch window instance.
......
......@@ -95,7 +95,7 @@
opened ( it is locked by hierarchical access ).
</p>
*/
interface XHierarchicalStorageAccess
published interface XHierarchicalStorageAccess
{
// METHODS
//
......
......@@ -52,7 +52,7 @@
//============================================================================
/** represents common functionality for inplace embedded objects.
*/
interface XInplaceObject: com::sun::star::uno::XInterface
published interface XInplaceObject: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** sets the visible part of the inplace object.
......
......@@ -62,7 +62,7 @@
//=============================================================================
/** allows to create and initialize a new embedded object using GUI dialog.
*/
interface XInsertObjectDialog: com::sun::star::uno::XInterface
published interface XInsertObjectDialog: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** creates a new object using GUI dialog.
......
......@@ -62,7 +62,7 @@
it will be detected.
</p>
*/
interface XLinkCreator: com::sun::star::uno::XInterface
published interface XLinkCreator: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** creates a new object based on
......
......@@ -58,7 +58,7 @@
//============================================================================
/** allows to create and initialize a new link of specified type.
*/
interface XLinkFactory: com::sun::star::uno::XInterface
published interface XLinkFactory: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** creates a new link and transport parameters for persistent
......
......@@ -54,7 +54,7 @@
//============================================================================
/** specifies an additional implementation for linked embedded object support.
*/
interface XLinkageSupport: XCommonEmbedPersist
published interface XLinkageSupport: XCommonEmbedPersist
{
//------------------------------------------------------------------------
/** breaks the link and provides the object with a parent storage and a
......
......@@ -58,7 +58,7 @@ module com { module sun { module star { module embed {
subcomponents are either OLE storages themself or streams.
</p>
*/
interface XOLESimpleStorage
published interface XOLESimpleStorage
{
//INTERFACES
//
......
......@@ -97,7 +97,7 @@
time and will be depricated soon!
Another solution will be introduced as final one.
*/
interface XOptimizedStorage
published interface XOptimizedStorage
{
// -----------------------------------------------------------------------
/** allows to insert a raw stream representing nonencrypted stream with
......
......@@ -42,7 +42,7 @@
//=============================================================================
/** allows to convert file system folder tree in to a package.
*/
interface XPackageStructureCreator: com::sun::star::uno::XInterface
published interface XPackageStructureCreator: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** converts file system folder tree in to a package.
......
......@@ -46,7 +46,7 @@
//=============================================================================
/** allows to disconnect an object from its persistence.
*/
interface XPersistanceHolder: com::sun::star::uno::XInterface
published interface XPersistanceHolder: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** disconnects the object from the persistance.
......
......@@ -62,7 +62,7 @@
this tag is used as a uniqued identified of an entry.
</p>
*/
interface XRelationshipAccess : ::com::sun::star::uno::XInterface
published interface XRelationshipAccess : ::com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** allows to detect whether there is an entry with specified value of
......
......@@ -44,7 +44,7 @@ module com { module sun { module star { module embed {
/** broadcasts message in case embedded object object changes it's state.
*/
interface XStateChangeBroadcaster: com::sun::star::uno::XInterface
published interface XStateChangeBroadcaster: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** adds the specified listener to receive events about states change
......
......@@ -48,7 +48,7 @@ module com { module sun { module star { module embed {
/** makes it possible to receive events when an embedded object changes it's
state.
*/
interface XStateChangeListener: com::sun::star::lang::XEventListener
published interface XStateChangeListener: com::sun::star::lang::XEventListener
{
//------------------------------------------------------------------------
/** is called just before the object changes state.
......
......@@ -91,7 +91,7 @@
//============================================================================
/** This interface represents main storage functionality.
*/
interface XStorage
published interface XStorage
{
// INTERFACES
//
......
......@@ -79,7 +79,7 @@
//============================================================================
/** This interface represents main storage functionality.
*/
interface XStorageRawAccess
published interface XStorageRawAccess
{
// -----------------------------------------------------------------------
/** allows to get a plain raw stream representing a package stream.
......
......@@ -46,7 +46,7 @@
//============================================================================
/** allows transacted access to an object.
*/
interface XTransactedObject: com::sun::star::uno::XInterface
published interface XTransactedObject: com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** commits the changes made for object.
......
......@@ -44,7 +44,7 @@ module com { module sun { module star { module embed {
/** broadcasts messege in case transacted object is commited or reverted.
*/
interface XTransactionBroadcaster: com::sun::star::uno::XInterface
published interface XTransactionBroadcaster: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** adds the specified listener to receive events about commits and
......
......@@ -48,7 +48,7 @@ module com { module sun { module star { module embed {
/** makes it possible to receive events when a transacted object is commited
or reverted.
*/
interface XTransactionListener: com::sun::star::lang::XEventListener
published interface XTransactionListener: com::sun::star::lang::XEventListener
{
//------------------------------------------------------------------------
/** is called just before the object is commited.
......
......@@ -40,7 +40,7 @@
<type scope="com::sun::star::datatransfer">XTransferable</type>
implementation from the object.
*/
interface XTransferableSupplier: com::sun::star::uno::XInterface
published interface XTransferableSupplier: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** allows to get access to
......
......@@ -55,7 +55,7 @@
//=============================================================================
/** represents common visualisation functionality for embedded objects.
*/
interface XVisualObject: ::com::sun::star::uno::XInterface
published interface XVisualObject: ::com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** sets the size of object's visual area.
......
......@@ -38,7 +38,7 @@
//============================================================================
/** provides access to a vcl window implementation.
*/
interface XWindowSupplier: com::sun::star::uno::XInterface
published interface XWindowSupplier: com::sun::star::uno::XInterface
{
//------------------------------------------------------------------------
/** allows to get access to a vcl window implementation.
......
......@@ -57,6 +57,7 @@ IDLFILES=\
Storage.idl\
StorageStream.idl\
StorageFactory.idl\
StorageFormats.idl\
VerbAttributes.idl\
VisualRepresentation.idl\
VerbDescriptor.idl\
......
......@@ -41,7 +41,7 @@
// DocMerge from xml: exception com::sun::star::packages::NoEncryptionException
/** This exception can be thrown in case object is not encrypted one as expected.
*/
exception NoEncryptionException: com::sun::star::uno::Exception
published exception NoEncryptionException: com::sun::star::uno::Exception
{
};
......
......@@ -42,7 +42,7 @@
/** This exception can be thrown in case provided stream is not a raw stream
representing encrypted package stream.
*/
exception NoRawFormatException: com::sun::star::io::IOException
published exception NoRawFormatException: com::sun::star::io::IOException
{
};
......
......@@ -41,7 +41,7 @@
// DocMerge from xml: exception com::sun::star::packages::WrongPasswordException
/** This exception can be thrown in case wrong password was provided.
*/
exception WrongPasswordException: com::sun::star::uno::Exception
published exception WrongPasswordException: com::sun::star::uno::Exception
{
};
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment