Attachment #12253 for issue #24084

View | Details | Raw Unified | Return to issue 24084
Collapse All | Expand All

Lines 117-123 Link Here

(-)Storage.idl (-2 / +3 lines)
117	specified name exists in a storage.	117	specified name exists in a storage.
118	<p>	118	<p>
119	It is also possible to use this interface to get read access to a child	119	It is also possible to use this interface to get read access to a child
120	element by <type>XNameAccess</type>::getByName() call. But the recommended way is to	120	element by <type scope="com::sun::star::container">XNameAccess</type>::getByName() call. But the recommended way is to
121	use <type>XStorage</type> interface for this purpose.	121	use <type>XStorage</type> interface for this purpose.
122	</p>	122	</p>
123	*/	123	*/
Lines 148-154 Link Here
148	</p>	148	</p>
149		149
150	<p>	150	<p>
151	In case a storage is disposed any call to it's methods should result in <type>DisposedException</type>.	151	In case a storage is disposed any call to it's methods should result in
		152	<type scope="com::sun::star::lang">DisposedException</type>.
152	</p>	153	</p>
153	*/	154	*/
154	interface ::com::sun::star::lang::XComponent;	155	interface ::com::sun::star::lang::XComponent;




{
	//================================================================
	/** A storage can be created through this interface.
		In case <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member> call is used
	the result storage will be open in readwrite mode based on an arbitrary medium.
		In case <member scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</member> call is used
	a sequence of the following parameters can be used:
		parameter 1 - specifies source of the object, it can be a string containing URL,
					  an <type scope="com::sun::star::io">XStream</type> implementation or
                      <type scope="com::sun::star::io">XInputStream</type>;
					  in case of <type scope="com::sun::star::io">XStream</type> implementation the <type scope="com::sun::star::io">XSeekable</type>
					  interface must be supported.
		parameter 2 - specifies mode the storage should be open in, can take values from 
					  <type>ElementModes</type> constant set.
		parameter 3 - allowes to provide <type scope="com::sun::star::document">MediaDescriptor</type> to the storage so some parts
					  can be used for initialization, it can be for example <type scope="com::sun::star::task">XInteractionHandler</type>
					  implementation, password for the storage and repair package flag;
	The parameters are optional, that means that sequence can be empty or contain only first parameter,
	or first and second one. In case no parameters are provided the call works the same way as
	<type scope="com::sun::star::lang">XSingleServiceFactory</type>::createInstance(). In case only first parameter is provided,
	the storage is opened in readonly mode.
		The opened root storage can support read access in addition to specified one.
	 */




service StorageStream
{
	//================================================================
	/** Allows to get access to <type scope="com::sun::star::io">XInputStream</type> and <type scope="com::sun::star::io">XOutputStream</type>
	implementations. In case the storage stream is open readonly the returned reference 
	to <type scope="com::sun::star::io">XOutputStream</type> will be empty.
	*/
	interface ::com::sun::star::io::XStream;


	until all the readonly instances are disposed.
	</p>
	<p>
		The stream must be disposed by <member scope="com::sun::star::lang">XComponent::dispose</member> call or by explicit closing
	of input and output ( if provided ) streams implementations with 
	<member scope="com::sun::star::io">XInputStream::closeInput</member> and
    <member scope="com::sun::star::io">XOutputStream::closeOutput</member> calls.
	Until stream is not disposed the changes written to it will be ignored during commit of parent storage.
		In case parent storage is disposed the stream is disposed automatically.
	</p>
	<p>
		In case a stream is disposed any call to it's methods should result in <type scope="com::sun::star::lang">DisposedException</type>.
	</p>
	 */
	interface ::com::sun::star::lang::XComponent;

Lines 154-160 Link Here

(-)XEmbedObjectFactory.idl (-2 / +2 lines)
154	::com::sun::star::uno::Exception );	154	::com::sun::star::uno::Exception );
155		155
156	//-------------------------------------------------------------------------	156	//-------------------------------------------------------------------------
157	/** Creates a new object and initializes it based on <type>MediaDescriptor</type>.	157	/** Creates a new object and initializes it based on <type scope="com::sun::star::document">MediaDescriptor</type>.
158		158
159	<p> In case specified entry exists it will be overwritten on storing.	159	<p> In case specified entry exists it will be overwritten on storing.
160	</p>	160	</p>
Lines 166-172 Link Here
166	a name for the entry	166	a name for the entry
167		167
168	@param aMediaDescriptor	168	@param aMediaDescriptor
169	an object of type <type>MediaDescriptor</type> that specifies source	169	an object of type <type scope="com::sun::star::document">MediaDescriptor</type> that specifies source
170		170
171	@thrown ::com::sun::star::lang::IllegalArgumentException	171	@thrown ::com::sun::star::lang::IllegalArgumentException
172	one of arguments is illegal	172	one of arguments is illegal

Lines 160-166 Link Here

(-)XStorage.idl (-1 / +1 lines)
160		160
161	<p>	161	<p>
162	This method returns <type>StorageStream</type> service implementation.	162	This method returns <type>StorageStream</type> service implementation.
163	In case the stream is open in readonly mode the <type>XStream</type>::getOutputStream()	163	In case the stream is open in readonly mode the <type scope="com::sun::star::io">XStream</type>::getOutputStream()
164	method will return an empty reference.	164	method will return an empty reference.
165	</p>	165	</p>
166		166

Return to issue 24084

Lines 79-100 Link Here

(-)StorageFactory.idl (-7 / +8 lines)
79	{	79	{
80	//================================================================	80	//================================================================
81	/** A storage can be created through this interface.	81	/** A storage can be created through this interface.
82	In case <type>XSingleServiceFactory</type>::createInstance() call is used	82	In case <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member> call is used
83	the result storage will be open in readwrite mode based on an arbitrary medium.	83	the result storage will be open in readwrite mode based on an arbitrary medium.
84	In case <type>XSingleServiceFactory</type>::createInstanceWithArguments() call is used	84	In case <member scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</member> call is used
85	a sequence of the following parameters can be used:	85	a sequence of the following parameters can be used:
86	parameter 1 - specifies source of the object, it can be a string containing URL,	86	parameter 1 - specifies source of the object, it can be a string containing URL,
87	an <type>XStream</type> implementation or <type>XInputStream</type>;	87	an <type scope="com::sun::star::io">XStream</type> implementation or
88	in case of <type>XStream</type> implementation the <type>XSeekable</type>	88	<type scope="com::sun::star::io">XInputStream</type>;
		89	in case of <type scope="com::sun::star::io">XStream</type> implementation the <type scope="com::sun::star::io">XSeekable</type>
89	interface must be supported.	90	interface must be supported.
90	parameter 2 - specifies mode the storage should be open in, can take values from	91	parameter 2 - specifies mode the storage should be open in, can take values from
91	<type>ElementModes</type> constant set.	92	<type>ElementModes</type> constant set.
92	parameter 3 - allowes to provide <type>MediaDescryptor</type> to the storage so some parts	93	parameter 3 - allowes to provide <type scope="com::sun::star::document">MediaDescriptor</type> to the storage so some parts
93	can be used for initialization, it can be for example <type>XInteractionHandler</type>	94	can be used for initialization, it can be for example <type scope="com::sun::star::task">XInteractionHandler</type>
94	implementation, password for the storage and repair package flag;	95	implementation, password for the storage and repair package flag;
95	The parameters are optional, that means that sequence can be empty or contain only first parameter,	96	The parameters are optional, that means that sequence can be empty or contain only first parameter,
96	or first and second one. In case no parameters are provided the call works the same way as	97	or first and second one. In case no parameters are provided the call works the same way as
97	<type>XSingleServiceFactory</type>::createInstance(). In case only first parameter is provided,	98	<type scope="com::sun::star::lang">XSingleServiceFactory</type>::createInstance(). In case only first parameter is provided,
98	the storage is opened in readonly mode.	99	the storage is opened in readonly mode.
99	The opened root storage can support read access in addition to specified one.	100	The opened root storage can support read access in addition to specified one.
100	*/	101	*/

Lines 97-105 Link Here

(-)StorageStream.idl (-5 / +6 lines)
97	service StorageStream	97	service StorageStream
98	{	98	{
99	//================================================================	99	//================================================================
100	/** Allows to get access to <type>XInputStream</type> and <type>XOutputStream</type>	100	/** Allows to get access to <type scope="com::sun::star::io">XInputStream</type> and <type scope="com::sun::star::io">XOutputStream</type>
101	implementations. In case the storage stream is open readonly the returned reference	101	implementations. In case the storage stream is open readonly the returned reference
102	to <type>XOutputStream</type> will be empty.	102	to <type scope="com::sun::star::io">XOutputStream</type> will be empty.
103	*/	103	*/
104	interface ::com::sun::star::io::XStream;	104	interface ::com::sun::star::io::XStream;
105		105
Lines 115-128 Link Here
115	until all the readonly instances are disposed.	115	until all the readonly instances are disposed.
116	</p>	116	</p>
117	<p>	117	<p>
118	The stream must be disposed by <type>XComponent</type>::dispose() call or by explicit closing	118	The stream must be disposed by <member scope="com::sun::star::lang">XComponent::dispose</member> call or by explicit closing
119	of input and output ( if provided ) streams implementations with	119	of input and output ( if provided ) streams implementations with
120	<type>XInputStream</type>::closeInput() and <type>XOutputStream</type>::closeOutput() calls.	120	<member scope="com::sun::star::io">XInputStream::closeInput</member> and
		121	<member scope="com::sun::star::io">XOutputStream::closeOutput</member> calls.
121	Until stream is not disposed the changes written to it will be ignored during commit of parent storage.	122	Until stream is not disposed the changes written to it will be ignored during commit of parent storage.
122	In case parent storage is disposed the stream is disposed automatically.	123	In case parent storage is disposed the stream is disposed automatically.
123	</p>	124	</p>
124	<p>	125	<p>
125	In case a stream is disposed any call to it's methods should result in <type>DisposedException</type>.	126	In case a stream is disposed any call to it's methods should result in <type scope="com::sun::star::lang">DisposedException</type>.
126	</p>	127	</p>
127	*/	128	*/
128	interface ::com::sun::star::lang::XComponent;	129	interface ::com::sun::star::lang::XComponent;