mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

*api: fix up merge conflict damage

Browse Source 
Change-Id: I3a1281c756305f16d193210839ca6b826662698e
This commit is contained in:
Michael Stahl
2013-05-31 00:06:50 +02:00
parent b24ef80b52
commit bcfcd0eb56
10 changed files with 143 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
offapi/com/sun/star/awt/ImageDrawMode.idl
View File

@@ -22,7 +22,7 @@ module com { module sun { module star { module awt {
/** defines modes how an image is drawn onto a device /** defines modes how an image is drawn onto a device
@see <member scope="com::sun::star::awt">XGraphics2::drawImage</member> @see com::sun::star::awt::XGraphics2::drawImage()
@since LibreOffice 4.1 @since LibreOffice 4.1
*/ */
constants ImageDrawMode constants ImageDrawMode
@@ -36,12 +36,12 @@ constants ImageDrawMode
const short DISABLE = 0x0001; const short DISABLE = 0x0001;
/** the image is drawn as being highlighted. /** the image is drawn as being highlighted.
See <member scope="com::sun::star::awt">XStyleSettings::HighlightColor</member>. See com::sun::star::awt::XStyleSettings::HighlightColor.
*/ */
const short HIGHLIGHT = 0x0002; const short HIGHLIGHT = 0x0002;
/** the image is drawn as being deactivated. /** the image is drawn as being deactivated.
See <member scope="com::sun::star::awt">XStyleSettings::DeactiveColor</member>. See com::sun::star::awt::XStyleSettings::DeactiveColor.
*/ */
const short DEACTIVE = 0x0004; const short DEACTIVE = 0x0004;

6
offapi/com/sun/star/awt/XGraphics2.idl
View File

@@ -36,7 +36,7 @@ published interface XGraphics2: com::sun::star::awt::XGraphics
void clear( [in] Rectangle aRect ); void clear( [in] Rectangle aRect );
/** draws a <type scope="com::sun::star::graphic">XGraphic</type> /** draws a com::sun::star::graphic::XGraphic
in the output device. in the output device.
<p>Note that some devices may not support this operation.</p> <p>Note that some devices may not support this operation.</p>
@@ -57,10 +57,10 @@ published interface XGraphics2: com::sun::star::awt::XGraphics
@param nStyle @param nStyle
the style used to draw the image. the style used to draw the image.
See <type scope="com::sun::star::awt">ImageDrawMode</type>. See com::sun::star::awt::ImageDrawMode.
@param aGraphic @param aGraphic
the <type scope="com::sun::star::graphic">XGraphic</type> the com::sun::star::graphic::XGraphic
to be drawn onto the device to be drawn onto the device
*/ */
void drawImage( [in] long nX, void drawImage( [in] long nX,

9
offapi/com/sun/star/frame/XLoaderFactory.idl
View File

@@ -37,8 +37,8 @@ published interface XLoaderFactory
/** interface to create loader objects by using his internal name /** interface to create loader objects by using his internal name
<p> <p>
Returned objects must support the service specification of a <type>FrameLoader</type> Returned objects must support the service specification of a FrameLoader
or <type>SynchronousFrameLoader</type>. (Note: last one will be preferred if both ones or SynchronousFrameLoader. (Note: last one will be preferred if both
are available) are available)
They can be created by using of his internal name, which must be unambiguous everytime, only. They can be created by using of his internal name, which must be unambiguous everytime, only.
To get this name use further specified interfaces of this factory for access on To get this name use further specified interfaces of this factory for access on
@@ -50,8 +50,9 @@ published interface XLoaderFactory
/** provides access to the whole frame loader configuration /** provides access to the whole frame loader configuration
<p>This interface supports an access to the internal configuration of all accessible loader objects. <p>This interface supports an access to the internal configuration of all accessible loader objects.
The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member> The return value of com::sun::star::container::XNameAccess::getByName()
is a property sequence packed in an any. </p> is a property sequence packed in an any.
</p>
<table border=1> <table border=1>
<tr> <tr>
<td><b>Types<b></td> <td><b>Types<b></td>

16
offapi/com/sun/star/frame/XStatusbarController.idl
View File

@@ -60,28 +60,28 @@ interface XStatusbarController
<p>A status bar controller is initialized with <b>five</b> additional <p>A status bar controller is initialized with <b>five</b> additional
arguments provided as a sequence of arguments provided as a sequence of
<type scope="com::sun::star::beans">PropertyValue</type>:</p> com::sun::star::beans::PropertyValue:</p>
<ul> <ul>
<li><b>Frame</b><br/>a <type scope="com::sun::star::frame">XFrame</type> <li><b>Frame</b><br/>a com::sun::star::frame::XFrame
instance to which the status bar controller belongs. instance to which the status bar controller belongs.
</li> </li>
<li><b>CommandURL</b><br/>a string which specifies the command <li><b>CommandURL</b><br/>a string which specifies the command
associated with the statusbar controller.</br> associated with the statusbar controller.<br>
The command is used to identify the status bar controller The command is used to identify the status bar controller
implementation. implementation.
</li> </li>
<li><b>StatusbarItem</b><br/>a <type scope="com::sun::star::ui">XStatusbarItem</type> <li><b>StatusbarItem</b><br/>a com::sun::star::ui::XStatusbarItem
instance which represents the status bar item asociated with instance which represents the status bar item asociated with
this controller. this controller.
</li> </li>
<li><b>ParentWindow</b><br/>a <type scope="com::sun::star::awt">Window</type> <li><b>ParentWindow</b><br/>a com::sun::star::awt::Window
instance which represents the parent window (status bar window). instance which represents the parent window (status bar window).
</li> </li>
<li><b>ModuleName</b><br/>a string which specifies the name of the <li><b>ModuleName</b><br/>a string which specifies the name of the
office module attached to the frame to which this controller office module attached to the frame to which this controller
belongs; the value is taken from belongs; the value is taken from
<member scope="com::sun::star::frame">XModuleManager::identify()</member>. com::sun::star::frame::XModuleManager::identify().
</li> </li>
</ul> </ul>
*/ */
@@ -91,7 +91,7 @@ interface XStatusbarController
changed. changed.
<p>The status bar controller implementation should register itself as a <p>The status bar controller implementation should register itself as a
listener when its <member scope="com::sun::star::util">XUpdatable</member> listener when its com::sun::star::util::XUpdatable
interface has been called.</p> interface has been called.</p>
*/ */
interface com::sun::star::frame::XStatusListener; interface com::sun::star::frame::XStatusListener;
@@ -157,7 +157,7 @@ interface XStatusbarController
@param nCommand @param nCommand
describes which command has been invoked. describes which command has been invoked.
<br/>See <type scope="com::sun::star::awt">Command</type> for <br/>See com::sun::star::awt::Command for
possible values. possible values.
@param bMouseEvent @param bMouseEvent

8
offapi/com/sun/star/frame/XUIControllerFactory.idl
View File

@@ -42,20 +42,20 @@ interface XUIControllerFactory
/** this interface provides functions to create new instances of a registered UI controller. /** this interface provides functions to create new instances of a registered UI controller.
<p> <p>
Use <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithArgumentsAndContext()</member> to create Use com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext() to create
a new UI controller instance. Use the CommandURL as the service specifier. a new UI controller instance. Use the CommandURL as the service specifier.
This call supports the following arguments provided as com::sun::star::beans::PropertyValue: This call supports the following arguments provided as com::sun::star::beans::PropertyValue:
<ul> <ul>
<li> <li>
<b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type> <b>Frame</b><br>specifies the com::sun::star::frame::XFrame
instance to which the UI controller belongs to. This property must be provided to instance to which the UI controller belongs to. This property must be provided to
the UI controller, otherwise it cannot dispatch its internal commands. the UI controller, otherwise it cannot dispatch its internal commands.
</li> </li>
<li> <li>
<b>ModuleIdentifier</b><br>optional string that specifies in which module context the UI <b>ModuleIdentifier</b><br>optional string that specifies in which module context the UI
controller should be created.</br>The module identifier can be retrieved using the controller should be created.<br>The module identifier can be retrieved using the
<type>ModuleManager</type>. ModuleManager.
</li> </li>
</ul> </ul>
</p> </p>

2
offapi/com/sun/star/text/ViewSettings.idl
View File

@@ -248,7 +248,7 @@ published service ViewSettings
*/ */
[optional, property] long VerticalRulerMetric; [optional, property] long VerticalRulerMetric;
//------------------------------------------------------------------------- //-------------------------------------------------------------------------
/** If this property is <TRUE/>, tips for document content are shown, /** If this property is `TRUE`, tips for document content are shown,
typically in a help balloon when the mouse is over the content. typically in a help balloon when the mouse is over the content.
@since LibreOffice 4.1 @since LibreOffice 4.1

19
offapi/com/sun/star/text/XAutoTextContainer.idl
View File

@@ -27,14 +27,14 @@
module com { module sun { module star { module text { module com { module sun { module star { module text {
/** handles blocks of <type>AutoTextEntry</type>. /** handles blocks of AutoTextEntry.
@see AutoTextContainer @see AutoTextContainer
*/ */
published interface XAutoTextContainer: com::sun::star::container::XNameAccess published interface XAutoTextContainer: com::sun::star::container::XNameAccess
{ {
/** creates a new AutoText group. /** creates a new AutoText group.
@param aGroupName the name of the <type>AutoTextContainer</type> @param aGroupName the name of the AutoTextContainer
<p>The name must follow the pattern <code>groupname*pathid</code>, where:</p> <p>The name must follow the pattern <code>groupname*pathid</code>, where:</p>
@@ -46,7 +46,7 @@ published interface XAutoTextContainer: com::sun::star::container::XNameAccess
<li><code>pathid</code> is a number (0 or 1) identifying the directory <li><code>pathid</code> is a number (0 or 1) identifying the directory
where the AutoText file is stored. Paths are stored in the Office where the AutoText file is stored. Paths are stored in the Office
configuration and accessed through configuration and accessed through
<member scope="com::sun::star::util">PathSettings::AutoText</member>. com::sun::star::util::PathSettings::AutoText.
<ul> <ul>
<li>0 indicates the path of the <b>Office Basis</b> layer</li> <li>0 indicates the path of the <b>Office Basis</b> layer</li>
<li>1 indicates the path of the <b>user</b> directory</li> <li>1 indicates the path of the <b>user</b> directory</li>
@@ -54,15 +54,15 @@ published interface XAutoTextContainer: com::sun::star::container::XNameAccess
</li> </li>
</ul> </ul>
If only <code>groupname</code> is specified, the path defaults to 0, the If only <code>groupname</code> is specified, the path defaults to 0, the
<b>Office Basis</b> layer.</br>Note that in some systems the user may lack of <b>Office Basis</b> layer.<br>Note that in some systems the user may lack of
write access to the Office Basis directory. write access to the Office Basis directory.
@example Example:
<ul> <ul>
<li><code>standard*0</code></br>the "standard" AutoTextGroup in the Office Basis layer</li> <li><code>standard*0</code><br>the "standard" AutoTextGroup in the Office Basis layer</li>
<li><code>template</code></br>the "template" AutoTextGroup in the Office Basis layer</li> <li><code>template</code><br>the "template" AutoTextGroup in the Office Basis layer</li>
<li><code>mytexts*1</code></br>the "mytexts" AutoTextGroup in the user directory</li> <li><code>mytexts*1</code><br>the "mytexts" AutoTextGroup in the user directory</li>
</ul> </ul>
*/ */
@@ -71,7 +71,8 @@ published interface XAutoTextContainer: com::sun::star::container::XNameAccess
com::sun::star::container::ElementExistException ); com::sun::star::container::ElementExistException );
/** deletes the specified AutoText group. /** deletes the specified AutoText group.
@param aGroupName see the documentation for <member>XAutoTextContainer::insertNewByName()</member> @param aGroupName
see the documentation for XAutoTextContainer::insertNewByName()
*/ */
void removeByName( [in] string aGroupName ) void removeByName( [in] string aGroupName )
raises( com::sun::star::container::NoSuchElementException ); raises( com::sun::star::container::NoSuchElementException );

204
offapi/com/sun/star/ucb/Content.idl
View File

@@ -82,18 +82,15 @@ published service Content
<h4>Mandatory commands</h4> <h4>Mandatory commands</h4>
<table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
<thead>
<tr> <tr>
<th>Command Name</th> <th>Command Name</th>
<th>Return Type</th> <th>Return Type</th>
<th>Parameters</th> <th>Parameters</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
</thead>
<tbody>
<tr> <tr>
<td>getCommandInfo</td> <td>getCommandInfo</td>
<td><type>XCommandInfo</type></td> <td>XCommandInfo</td>
<td>void</td> <td>void</td>
<td>This command obtains an interface which allows to query <td>This command obtains an interface which allows to query
information on commands supported by a content. information on commands supported by a content.
@@ -101,7 +98,7 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>getPropertySetInfo</td> <td>getPropertySetInfo</td>
<td><type scope="com::sun::star::beans">XPropertySetInfo</type></td> <td>com::sun::star::beans::XPropertySetInfo</td>
<td>void</td> <td>void</td>
<td>This command obtains an interface which allows to query <td>This command obtains an interface which allows to query
information on properties supported by a content. information on properties supported by a content.
@@ -109,8 +106,8 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>getPropertyValues</td> <td>getPropertyValues</td>
<td><type scope="com::sun::star::sdbc">XRow</type></td> <td>com::sun::star::sdbc::XRow</td>
<td>sequence&lt; <type scope="com::sun::star::beans">Property</type> &gt; aProps</td> <td>sequence&lt; com::sun::star::beans::Property &gt; aProps</td>
<td>This command obtains property values from the content. <td>This command obtains property values from the content.
<blockquote> <blockquote>
<b>Note</b>: The execution will not be aborted, if there <b>Note</b>: The execution will not be aborted, if there
@@ -123,7 +120,7 @@ published service Content
<tr> <tr>
<td>setPropertyValues</td> <td>setPropertyValues</td>
<td>sequence&lt; any &gt;</td> <td>sequence&lt; any &gt;</td>
<td>sequence&lt; <type scope="com::sun::star::beans">PropertyValue</type> &gt; aValues</td> <td>sequence&lt; com::sun::star::beans::PropertyValue &gt; aValues</td>
<td>This command sets property values of the content. <td>This command sets property values of the content.
<p>Note that setPropertyValues does not throw an exception in the case <p>Note that setPropertyValues does not throw an exception in the case
that one or more of the requested property values cannot be set. that one or more of the requested property values cannot be set.
@@ -133,131 +130,127 @@ published service Content
of elements like the number of properties to set. Every sequence of elements like the number of properties to set. Every sequence
element contains the status for a property. The first sequence element contains the status for a property. The first sequence
elements corresponds to the first element in the sequence of elements corresponds to the first element in the sequence of
<type scope="com::sun::star::beans">PropertyValue</type>s passed as com::sun::star::beans::PropertyValue passed as
command argument, and so on. The exceptions will never be passed to command argument, and so on. The exceptions will never be passed to
an <type scope="com::sun::star::task">InteractionHandler</type>.</p> an com::sun::star::task::InteractionHandler.</p>
<p>Every element in the returned sequence is an any containing:</p> <p>Every element in the returned sequence is an any containing:</p>
<ul> <ul>
<li>No value indicates, that the property value was set successfully.</li> <li>No value indicates, that the property value was set successfully.</li>
<li><type scope="com::sun::star::beans">UnknownPropertyException</type> <li>com::sun::star::beans::UnknownPropertyException
indicates, that the property is not known to the content indicates, that the property is not known to the content
implementation.</li> implementation.</li>
<li><type scope="com::sun::star::beans">IllegalTypeException</type> <li>com::sun::star::beans::IllegalTypeException
indicates, that the data type of the property value is not indicates, that the data type of the property value is not
acceptable.</li> acceptable.</li>
<li><type scope="com::sun::star::lang">IllegalAccessException</type> <li>com::sun::star::lang::IllegalAccessException
indicates, that the property is constant indicates, that the property is constant
(<member scope="com::sun::star::beans">PropertyAttribute::READONLY</member> (com::sun::star::beans::PropertyAttribute::READONLY
is set).</li> is set).</li>
<li><type scope="com::sun::star::lang">IllegalArgumentException</type> <li>com::sun::star::lang::IllegalArgumentException
indicates, that the property value is not acceptable. For instance, indicates, that the property value is not acceptable. For instance,
setting an empty title may be illegal.</li> setting an empty title may be illegal.</li>
<li>Any other execption derived from <type scope="com::sun::star::uno">Exception</type> <li>Any other execption derived from com::sun::star::uno::Exception
indicates, that the value was not set successfully. For example, indicates, that the value was not set successfully. For example,
this can be a <type>InteractiveAugmentedIOException</type> this can be a InteractiveAugmentedIOException
transporting the error code <member>IOErrorCode::ACCESS_DENIED</member>.</li> transporting the error code IOErrorCode::ACCESS_DENIED.</li>
</ul> </ul>
<p>If the value to set is equal to the current value, no exception must <p>If the value to set is equal to the current value, no exception must
be added to the returned sequence</p> be added to the returned sequence</p>
</td> </td>
</tr> </tr>
</tbody>
</table> </table>
<h4>Optional commands</h4> <h4>Optional commands</h4>
<table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
<thead>
<tr> <tr>
<th>Command Name</th> <th>Command Name</th>
<th>Return Type</th> <th>Return Type</th>
<th>Parameters</th> <th>Parameters</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
</thead>
<tbody>
<tr> <tr>
<td>open</td> <td>open</td>
<td><type>XDynamicResultSet</type></td> <td>XDynamicResultSet</td>
<td><type>OpenCommandArgument2</type> aOpenCommandArg</td> <td>OpenCommandArgument2 aOpenCommandArg</td>
<td> <td>
For <b>folder</b> objects, this command will return an For <b>folder</b> objects, this command will return an
implementation of service <type>DynamicResultSet</type>. implementation of service DynamicResultSet.
<p>The <type>OpenCommandArgument2</type> members must be <p>The OpenCommandArgument2 members must be
filled as follows:</p> filled as follows:</p>
<ul> <ul>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Mode</member>: <li>com::sun::star::ucb::OpenCommandArgument::Mode:
<const scope="com::sun::star::ucb">OpenMode::ALL</const> or com::sun::star::ucb::OpenMode::ALL or
<const scope="com::sun::star::ucb">OpenMode::FOLDERS</const> or com::sun::star::ucb::OpenMode::FOLDERS or
<const scope="com::sun::star::ucb">OpenMode::DOCUMENTS</const>. com::sun::star::ucb::OpenMode::DOCUMENTS.
The implementation of the open command MUST support all these modes! The implementation of the open command MUST support all these modes!
</li> </li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Priority</member>: <li>com::sun::star::ucb::OpenCommandArgument::Priority:
can be set, but implementation may ignore the value can be set, but implementation may ignore the value
</li> </li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Sink</member>: <li>com::sun::star::ucb::OpenCommandArgument::Sink:
empty( ignored ) empty( ignored )
</li> </li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Properties</member>: <li>com::sun::star::ucb::OpenCommandArgument::Properties:
The properties for which the result set shall The properties for which the result set shall
contain the property values. The order of the contain the property values. The order of the
sequence is the same as the order of result set sequence is the same as the order of result set
columns. First element of sequence will be row columns. First element of sequence will be row
number one, second will be row number two, ... number one, second will be row number two, ...
</li> </li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument2::SortingInfo</member>: <li>com::sun::star::ucb::OpenCommandArgument2::SortingInfo:
contains sort criteria, if result set shall contains sort criteria, if result set shall
be sorted, otherwise it can be left empty. be sorted, otherwise it can be left empty.
</li> </li>
</ul> </ul>
The exceution must be aborted by the implementation of this command The exceution must be aborted by the implementation of this command
(by throwing a <type>CommandAbortedException</type>), if an (by throwing a CommandAbortedException), if an
unsupported mode is requested. unsupported mode is requested.
</td> </td>
</tr> </tr>
<tr> <tr>
<td>open</td> <td>open</td>
<td>void</td> <td>void</td>
<td><type>OpenCommandArgument2</type> aOpenCommandArg</td> <td>OpenCommandArgument2 aOpenCommandArg</td>
<td>For non-folder objects, the <type>OpenCommandArgument2</type> <td>For non-folder objects, the OpenCommandArgument2
struct will be prefilled with a data sink object, which struct will be prefilled with a data sink object, which
will be filled with the content data. will be filled with the content data.
<p>The <type>OpenCommandArgument2</type> members must be <p>The OpenCommandArgument2 members must be
filled as follows:</p> filled as follows:</p>
<ul> <ul>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Mode</member>: <li>com::sun::star::ucb::OpenCommandArgument::Mode:
<const scope="com::sun::star::ucb">OpenMode::DOCUMENT</const> or com::sun::star::ucb::OpenMode::DOCUMENT or
<const scope="com::sun::star::ucb">OpenMode::DOCUMENT_SHARE_DENY_NONE</const> or com::sun::star::ucb::OpenMode::DOCUMENT_SHARE_DENY_NONE or
<const scope="com::sun::star::ucb">OpenMode::DOCUMENT_SHARE_DENY_WRITE</const>. com::sun::star::ucb::OpenMode::DOCUMENT_SHARE_DENY_WRITE.
Support for DOCUMENT is mandatory, all others are optional. Support for DOCUMENT is mandatory, all others are optional.
</li> </li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Priority</member>: <li>com::sun::star::ucb">OpenCommandArgument::Priority:
can be set, but implementation may ignore the value can be set, but implementation may ignore the value
</li> </li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Sink</member>: <li>com::sun::star::ucb::OpenCommandArgument::Sink:
a sink, where the implementation can put the document data into. a sink, where the implementation can put the document data into.
</li> </li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument::Properties</member>: empty ( ignored )</li> <li>com::sun::star::ucb::OpenCommandArgument::Properties: empty ( ignored )</li>
<li><member scope="com::sun::star::ucb">OpenCommandArgument2::SortingInfo</member>: empty ( ignored )</li> <li>com::sun::star::ucb">OpenCommandArgument2::SortingInfo: empty ( ignored )</li>
</ul> </ul>
<p>The exceution must be aborted by the implementation of this command <p>The exceution must be aborted by the implementation of this command
(by throwing a <type>CommandAbortedException</type>), if an (by throwing a CommandAbortedException), if an
unsupported mode is requested.</p> unsupported mode is requested.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>createNewContent</td> <td>createNewContent</td>
<td><type>XContent</type></td> <td>XContent</td>
<td><type>ContentInfo</type> contentinfo</td> <td>ContentInfo contentinfo</td>
<td> <td>
This command creates a new <b>non-persistent</b> content of a given type. This command creates a new <b>non-persistent</b> content of a given type.
<p>This command must be supported by every <type>Content</type> <p>This command must be supported by every Content
that supports the property "CreatableContentsInfo", if the returned that supports the property "CreatableContentsInfo", if the returned
property value contains a non-empty sequence of creatable types. property value contains a non-empty sequence of creatable types.
<blockquote> <blockquote>
Note: This command is part of the replacement for the deprecated Note: This command is part of the replacement for the deprecated
interface <type>XContentCreator</type>. interface XContentCreator.
</blockquote> </blockquote>
<p>Creation of a new <b>persistent</b> content: <p>Creation of a new <b>persistent</b> content:
<ol> <ol>
@@ -273,13 +266,13 @@ published service Content
<tr> <tr>
<td>insert</td> <td>insert</td>
<td>void</td> <td>void</td>
<td><type>InsertCommandArgument</type> aInsertCommandArg</td> <td>InsertCommandArgument aInsertCommandArg</td>
<td> <td>
<ol> <ol>
<li> <li>
This command inserts a <b>new content</b>. It commits the process of This command inserts a <b>new content</b>. It commits the process of
creating a new content via executing the command "createNewContent" creating a new content via executing the command "createNewContent"
and initializing it via setting properties, afterwards.</br> and initializing it via setting properties, afterwards.<br>
The command is not called on the content which created the new The command is not called on the content which created the new
content, because the new object already knows where it is to be content, because the new object already knows where it is to be
inserted (i.e. Calling createNewContent with the content type for a inserted (i.e. Calling createNewContent with the content type for a
@@ -288,10 +281,10 @@ published service Content
posting the article to the appropriate News Group). Not calling posting the article to the appropriate News Group). Not calling
"insert" for the new content, i.e. because the user cancels writing "insert" for the new content, i.e. because the user cancels writing
a new message, simply discards the new object. No extra call to a new message, simply discards the new object. No extra call to
"delete" is necessary.</br> "delete" is necessary.<br>
On successful completion of this command, the parent of the inserted On successful completion of this command, the parent of the inserted
content must propagate the change by notifying a content must propagate the change by notifying a
<type>ContentEvent</type> - <member>ContentAction::INSERTED</member>. ContentEvent - ContentAction::INSERTED.
</li> </li>
<li> <li>
Additionally this command can be called at any time to overwrite Additionally this command can be called at any time to overwrite
@@ -303,19 +296,19 @@ published service Content
<tr> <tr>
<td>update</td> <td>update</td>
<td>void</td> <td>void</td>
<td><type>OpenCommandArgument2</type> aOpenCommandArg</td> <td>OpenCommandArgument2 aOpenCommandArg</td>
<td>This command triggers an update operation on a content. <td>This command triggers an update operation on a content.
For example, when "updating" a POP3-Inbox, the content For example, when "updating" a POP3-Inbox, the content
for that box will get and store all new objects on the for that box will get and store all new objects on the
appropriate server. The inserted contents will be appropriate server. The inserted contents will be
notified by calling notified by calling
<member>XContentEventListener::contentEvent</member>. XContentEventListener::contentEvent().
</td> </td>
</tr> </tr>
<tr> <tr>
<td>synchronize</td> <td>synchronize</td>
<td>void</td> <td>void</td>
<td><type>OpenCommandArgument2</type> aOpenCommandArg</td> <td>OpenCommandArgument2 aOpenCommandArg</td>
<td> <td>
This command triggers a synchronization operation between locally This command triggers a synchronization operation between locally
cached data and remote server's data. For example, when cached data and remote server's data. For example, when
@@ -323,7 +316,7 @@ published service Content
store all new objects and destroy all cached data for objects no store all new objects and destroy all cached data for objects no
longer existing on the server. The inserted/deleted contents will longer existing on the server. The inserted/deleted contents will
be notified by calling be notified by calling
<member>XContent::contentEvent</member>. XContent::contentEvent().
</td> </td>
</tr> </tr>
<tr> <tr>
@@ -337,15 +330,15 @@ published service Content
<td>void</td> <td>void</td>
<td>boolean bDeletePhysically</td> <td>boolean bDeletePhysically</td>
<td> <td>
This command deletes an object. If <TRUE/> is passed as parameter, This command deletes an object. If `TRUE` is passed as parameter,
the object will be destroyed physically. Otherwise it will be put the object will be destroyed physically. Otherwise it will be put
into trash can, if such a service is available and the object to into trash can, if such a service is available and the object to
be deleted supports the command "undelete". be deleted supports the command "undelete".
On successful completion of this command, the deleted content On successful completion of this command, the deleted content
must propagate its deletion by notifying a <type>ContentEvent</type> must propagate its deletion by notifying a ContentEvent
- <member>ContentAction::DELETED</member>. Additionally, the contents - ContentAction::DELETED. Additionally, the contents
parent must notify a <type>ContentEvent</type> parent must notify a ContentEvent
- <member>ContentAction::REMOVED</member> - ContentAction::REMOVED
</td> </td>
</tr> </tr>
<tr> <tr>
@@ -360,60 +353,60 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>search</td> <td>search</td>
<td><type>XDynamicResultSet</type></td> <td>XDynamicResultSet</td>
<td><type>SearchCommandArgument</type> aSearchCommandArg</td> <td>SearchCommandArgument aSearchCommandArg</td>
<td> <td>
This command searches for subcontents of a content matching the This command searches for subcontents of a content matching the
given search criteria. The command will return an implemenation given search criteria. The command will return an implemenation
of service <type>DynamicResultSet</type>. of service DynamicResultSet.
</td> </td>
</tr> </tr>
<tr> <tr>
<td>transfer</td> <td>transfer</td>
<td>void</td> <td>void</td>
<td><type>TransferInfo</type> aTransferInfo</td> <td>TransferInfo aTransferInfo</td>
<td> <td>
<blockquote> <blockquote>
<b>Important note:</b> A client that wants to transfer data should <b>Important note:</b> A client that wants to transfer data should
not execute this command, but it should execute the command not execute this command, but it should execute the command
"globalTransfer" at the <type>UniversalContentBroker</type>. "globalTransfer" at the UniversalContentBroker.
This command is able to transfer all kind of content This command is able to transfer all kind of content
supported by that UCB. supported by that UCB.
</blockquote> </blockquote>
This command transfers (copies/moves) an object from one location This command transfers (copies/moves) an object from one location
to another. It must be executed at the folder content representing to another. It must be executed at the folder content representing
the <b>destination</b> of the transfer operation.</br> the <b>destination</b> of the transfer operation.<br>
Note that the implementation need not be able to handle Note that the implementation need not be able to handle
any type of contents.</br> any type of contents.<br>
Generally, there are good chances that a transfer of a content will Generally, there are good chances that a transfer of a content will
succeed, if source and target folder have the same URL scheme. succeed, if source and target folder have the same URL scheme.
But there is no guaranty for that.</br> But there is no guaranty for that.<br>
For instance, moving a message from a folder on IMAP server A For instance, moving a message from a folder on IMAP server A
to a folder on IMAP server B may fail, because the transfer to a folder on IMAP server B may fail, because the transfer
command can't be implemented efficiently for this scenario, command can't be implemented efficiently for this scenario,
because it is not directly supported by the IMAP protocol. because it is not directly supported by the IMAP protocol.
On the other hand, moving a message from one folder to On the other hand, moving a message from one folder to
another folder on the same IMAP server should work, because it can another folder on the same IMAP server should work, because it can
be implemeted efficiently.</br> be implemeted efficiently.<br>
If an implementation is not able to handle a given source URL, If an implementation is not able to handle a given source URL,
it should indicate this by issuing a it should indicate this by issuing a
<type>InteractiveBadTransferURLException</type> interaction request.</br> InteractiveBadTransferURLException interaction request.<br>
Source and target folder may be the same when doing a move operation. Source and target folder may be the same when doing a move operation.
</br> <br>
Transfers without the transfer command can be done as follows: Transfers without the transfer command can be done as follows:
<ol> <ol>
<li>Create a new content at the target folder</br> <li>Create a new content at the target folder<br>
<code>targetContent = target.execute( "createNewContent", type )</code> <code>targetContent = target.execute( "createNewContent", type )</code>
</li> </li>
<li>Transfer data from source to target content</br> <li>Transfer data from source to target content<br>
<code>props = sourceContent.execute( "getPropertyValues", ... )</code> <code>props = sourceContent.execute( "getPropertyValues", ... )</code>
<code>dataStream = sourceContent.execute( "open", ... )</code> <code>dataStream = sourceContent.execute( "open", ... )</code>
<code>targetContent.execute( "setPropertyValues", props )</code> <code>targetContent.execute( "setPropertyValues", props )</code>
</li> </li>
<li>Insert ( commit ) the new content</br> <li>Insert ( commit ) the new content<br>
<code>targetContent.execute( "insert", dataStream )</code> <code>targetContent.execute( "insert", dataStream )</code>
</li> </li>
<li>For move operations only: destroy the source content</br> <li>For move operations only: destroy the source content<br>
<code>sourceContent.execute( "delete", ... )</code> <code>sourceContent.execute( "delete", ... )</code>
</li> </li>
</ol> </ol>
@@ -429,11 +422,11 @@ published service Content
This command obtains an exlusive write lock for the resource. The This command obtains an exlusive write lock for the resource. The
lock is active until command "unlock" is executed, or the OOo lock is active until command "unlock" is executed, or the OOo
session that obtained the lock ends, or until the lock is released by session that obtained the lock ends, or until the lock is released by
a third party (e.g. a system administrator).</br> a third party (e.g. a system administrator).<br>
Exceptions: Exceptions:
<ul> <ul>
<li><type>InteractiveLockingLockedException</type></li> <li>InteractiveLockingLockedException</li>
<li><type>InteractiveLockingLockExpiredException</type></li> <li>InteractiveLockingLockExpiredException</li>
</ul> </ul>
</td> </td>
</tr> </tr>
@@ -443,33 +436,29 @@ published service Content
<td>void</td> <td>void</td>
<td> <td>
This command removes a lock obtained by executing the command "lock" This command removes a lock obtained by executing the command "lock"
from the resource.</br> from the resource.<br>
<p>Exceptions: <p>Exceptions:
<ul> <ul>
<li><type>InteractiveLockingLockedException</type></li> <li>InteractiveLockingLockedException</li>
<li><type>InteractiveLockingLockExpiredException</type></li> <li>InteractiveLockingLockExpiredException</li>
</ul> </ul>
</p> </p>
<p>Note that <type>InteractiveLockingLockExpiredException</type> might <p>Note that InteractiveLockingLockExpiredException might
be raised by any command that requires a previously obtained lock. be raised by any command that requires a previously obtained lock.
</p> </p>
</td> </td>
</tr> </tr>
</tbody>
</table> </table>
<h3>Properties</h3> <h3>Properties</h3>
<h4>Mandatory properties</h4> <h4>Mandatory properties</h4>
<table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
<thead>
<tr> <tr>
<th>Name</th> <th>Name</th>
<th>Type</th> <th>Type</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
</thead>
<tbody>
<tr> <tr>
<td>ContentType</td> <td>ContentType</td>
<td>string</td> <td>string</td>
@@ -502,20 +491,16 @@ published service Content
<td>string</td> <td>string</td>
<td>contains the title of an object (e.g. the subject of a message).</td> <td>contains the title of an object (e.g. the subject of a message).</td>
</tr> </tr>
</tbody>
</table> </table>
<h4>Optional properties</h4> <h4>Optional properties</h4>
<table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
<thead>
<tr> <tr>
<th>Name</th> <th>Name</th>
<th>Type</th> <th>Type</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
</thead>
<tbody>
<tr> <tr>
<td>AutoUpdateInterval</td> <td>AutoUpdateInterval</td>
<td>long</td> <td>long</td>
@@ -536,12 +521,12 @@ published service Content
<td>ConnectionMode</td> <td>ConnectionMode</td>
<td>short</td> <td>short</td>
<td>contains the current connection mode for the object. <td>contains the current connection mode for the object.
(see <type>ConnectionMode</type>) (see ConnectionMode)
</td> </td>
</tr> </tr>
<tr> <tr>
<td>CreatableContentsInfo</td> <td>CreatableContentsInfo</td>
<td>sequence <type>ContentInfo</type></td> <td>sequence ContentInfo</td>
<td> <td>
contains the types of Contents a Content object can create via contains the types of Contents a Content object can create via
command "createNewContent". command "createNewContent".
@@ -549,18 +534,18 @@ published service Content
Content must also support command "createNewContent".</p> Content must also support command "createNewContent".</p>
<blockquote> <blockquote>
Note: This property is part of the replacement for the deprecated Note: This property is part of the replacement for the deprecated
interface <type>XContentCreator</type>. interface XContentCreator.
</blockquote> </blockquote>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>DateCreated</td> <td>DateCreated</td>
<td><type scope"com::sun::star::util">DateTime</type></td> <td>com::sun::star::util::DateTime</td>
<td>contains the date and time the object was created.</td> <td>contains the date and time the object was created.</td>
</tr> </tr>
<tr> <tr>
<td>DateModified</td> <td>DateModified</td>
<td><type scope"com::sun::star::util">DateTime</type></td> <td>com::sun::star::util::DateTime</td>
<td>contains the date and time the object was last modified.</td> <td>contains the date and time the object was last modified.</td>
</tr> </tr>
<tr> <tr>
@@ -575,7 +560,7 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>DocumentHeader</td> <td>DocumentHeader</td>
<td>sequence&lt; <type>DocumentHeaderField</type> &gt; </td> <td>sequence&lt; DocumentHeaderField &gt; </td>
<td>contains a sequence of documemt header fields (i.e. header <td>contains a sequence of documemt header fields (i.e. header
fields of a MIME-message, or the document info of an fields of a MIME-message, or the document info of an
office document ). For some standard header fields there office document ). For some standard header fields there
@@ -584,7 +569,7 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>DocumentStoreMode</td> <td>DocumentStoreMode</td>
<td><type>DocumentStoreMode</type></td> <td>DocumentStoreMode</td>
<td>contains information about the way a folder stores the <td>contains information about the way a folder stores the
contents of (remote) documents. contents of (remote) documents.
</td> </td>
@@ -640,7 +625,7 @@ published service Content
<td>UpdateOnOpen</td> <td>UpdateOnOpen</td>
<td>boolean</td> <td>boolean</td>
<td>indicates whether (sub)contents shall be automatically updated <td>indicates whether (sub)contents shall be automatically updated
everytime a (folder) content is opened.</br>This property may be everytime a (folder) content is opened.<br>This property may be
used to control whether a folder content should read data only used to control whether a folder content should read data only
from local cache when it is opened, or whether it should connect from local cache when it is opened, or whether it should connect
to a server to obtain latest data.</td> to a server to obtain latest data.</td>
@@ -707,7 +692,7 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>Priority</td> <td>Priority</td>
<td><type>Priority</type></td> <td>Priority</td>
<td>contains a priority (i.e. of a message).</td> <td>contains a priority (i.e. of a message).</td>
</tr> </tr>
<tr> <tr>
@@ -717,7 +702,7 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>Rules</td> <td>Rules</td>
<td><type>RuleSet</type></td> <td>RuleSet</td>
<td>contains the rules set for a content.</td> <td>contains the rules set for a content.</td>
</tr> </tr>
<tr> <tr>
@@ -765,7 +750,7 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>SynchronizePolicy</td> <td>SynchronizePolicy</td>
<td><type>SynchronizePolicy</type></td> <td>SynchronizePolicy</td>
<td>contains the policy to use when synchronizing two objects.</td> <td>contains the policy to use when synchronizing two objects.</td>
</tr> </tr>
<tr> <tr>
@@ -815,16 +800,15 @@ published service Content
</tr> </tr>
<tr> <tr>
<td>VerificationMode</td> <td>VerificationMode</td>
<td><type>VerificationMode</type> </td> <td>VerificationMode </td>
<td>describes a verification policy.</td> <td>describes a verification policy.</td>
</tr> </tr>
</tbody>
</table> </table>
*/ */
interface com::sun::star::ucb::XCommandProcessor; interface com::sun::star::ucb::XCommandProcessor;
/** is an enhanced version of <type>XCommandProcessor</type> that has an /** is an enhanced version of XCommandProcessor that has an
additional method for releasing command identifiers obtained via additional method for releasing command identifiers obtained via
XCommandProcessor::createCommandIdentifier() to avoid XCommandProcessor::createCommandIdentifier() to avoid
resource leaks. For a detailed description of the problem refer to resource leaks. For a detailed description of the problem refer to
@@ -874,8 +858,8 @@ published service Content
@deprecated @deprecated
<p>This interface is <b>deprecated</b>, because a <p>This interface is <b>deprecated</b>, because a
<type>ContentProvider</type> might need a ContentProvider might need a
<type>XCommandEnvironment</type> to perform the tasks of adding and XCommandEnvironment to perform the tasks of adding and
removing properties. New implementations should implement the removing properties. New implementations should implement the
respective commands "addProperty" and "removeProperty" instead. respective commands "addProperty" and "removeProperty" instead.
*/ */

6
offapi/com/sun/star/ui/UICategoryDescription.idl
View File

@@ -41,11 +41,11 @@ module com { module sun { module star { module ui {
<p> <p>
To access the user interface command categories of a module, a unique To access the user interface command categories of a module, a unique
module specifier must be provided to module specifier must be provided to
<member scope="com::sun::star::container">XNameAccess::getByName()</member> com::sun::star::container::XNameAccess::getByName()
function. The module specifier can be retrieved from the function. The module specifier can be retrieved from the
<type scope="com::sun::star::frame">ModuleManager</type> com::sun::star::frame::ModuleManager
service. The interface provides references to service. The interface provides references to
<type scope="com::sun:star::ui">ModuleUICommandDescription</type>. com::sun:star::ui::ModuleUICommandDescription.
</p> </p>
@see com::sun::star::frame::ModuleManager @see com::sun::star::frame::ModuleManager

24
offapi/com/sun/star/ui/XStatusbarItem.idl
View File

@@ -25,7 +25,7 @@ module com { module sun { module star { module ui {
/** Represents an item in a status bar /** Represents an item in a status bar
@see <type scope="com::sun::star::frame">XStatusbarController</type> @see com::sun::star::frame::XStatusbarController
@since LibreOffice 4.1 @since LibreOffice 4.1
*/ */
@@ -49,23 +49,23 @@ interface XStatusbarItem
<ul> <ul>
<li>Alignment <li>Alignment
<ul> <ul>
<li><member scope="com::sun::star::ui">ItemStyle::ALIGN_LEFT</member></li> <li>com::sun::star::ui::ItemStyle::ALIGN_LEFT</li>
<li><member scope="com::sun::star::ui">ItemStyle::ALIGN_CENTER</member></li> <li>com::sun::star::ui::ItemStyle::ALIGN_CENTER</li>
<li><member scope="com::sun::star::ui">ItemStyle::ALIGN_RIGHT</member></li> <li>com::sun::star::ui::ItemStyle::ALIGN_RIGHT</li>
</ul> </ul>
</li> </li>
<li>Drawing <li>Drawing
<ul> <ul>
<li><member scope="com::sun::star::ui">ItemStyle::DRAW_OUT3D</member></li> <li>com::sun::star::ui::ItemStyle::DRAW_OUT3D</li>
<li><member scope="com::sun::star::ui">ItemStyle::DRAW_IN3D</member></li> <li>com::sun::star::ui::ItemStyle::DRAW_IN3D</li>
<li><member scope="com::sun::star::ui">ItemStyle::DRAW_FLAT</member></li> <li>com::sun::star::ui::ItemStyle::DRAW_FLAT</li>
</ul> </ul>
</li> </li>
<li><member scope="com::sun::star::ui">ItemStyle::AUTO_SIZE</member></li> <li>com::sun::star::ui::ItemStyle::AUTO_SIZE</li>
<li><member scope="com::sun::star::ui">ItemStyle::OWNER_DRAW</member></li> <li>com::sun::star::ui::ItemStyle::OWNER_DRAW</li>
</ul> </ul>
@see <type scope="com::sun::star::ui">ItemStyle</type> @see com::sun::star::ui::ItemStyle
*/ */
[attribute, readonly] unsigned short Style; [attribute, readonly] unsigned short Style;
@@ -75,7 +75,7 @@ interface XStatusbarItem
/** the rectangle on the status bar device onto which the item is drawn /** the rectangle on the status bar device onto which the item is drawn
@see <member scope="com::sun::star::frame">XStatusbarController::paint()</member> @see com::sun::star::frame::XStatusbarController::paint()
*/ */
[attribute, readonly] com::sun::star::awt::Rectangle ItemRect; [attribute, readonly] com::sun::star::awt::Rectangle ItemRect;
@@ -101,7 +101,7 @@ interface XStatusbarItem
/** forces repainting the item onto the status bar device /** forces repainting the item onto the status bar device
@see <member scope="com::sun::star::frame">XStatusbarController::paint()</member> @see com::sun::star::frame::XStatusbarController::paint()
*/ */
void repaint(); void repaint();
}; };