You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openoffice.apache.org by ms...@apache.org on 2018/12/31 14:38:35 UTC
svn commit: r1850050 - in /openoffice/trunk/main/udkapi/com/sun/star/beans:
Pair.idl Property.idl StringPair.idl XExactName.idl
XHierarchicalPropertySet.idl
Author: mseidel
Date: Mon Dec 31 14:38:35 2018
New Revision: 1850050
URL: http://svn.apache.org/viewvc?rev=1850050&view=rev
Log:
Removed whitespace, fixed typos
Modified:
openoffice/trunk/main/udkapi/com/sun/star/beans/Pair.idl
openoffice/trunk/main/udkapi/com/sun/star/beans/Property.idl
openoffice/trunk/main/udkapi/com/sun/star/beans/StringPair.idl
openoffice/trunk/main/udkapi/com/sun/star/beans/XExactName.idl
openoffice/trunk/main/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl
Modified: openoffice/trunk/main/udkapi/com/sun/star/beans/Pair.idl
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/udkapi/com/sun/star/beans/Pair.idl?rev=1850050&r1=1850049&r2=1850050&view=diff
==============================================================================
--- openoffice/trunk/main/udkapi/com/sun/star/beans/Pair.idl (original)
+++ openoffice/trunk/main/udkapi/com/sun/star/beans/Pair.idl Mon Dec 31 14:38:35 2018
@@ -1,5 +1,5 @@
/**************************************************************
- *
+ *
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -7,42 +7,48 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- *
+ *
*************************************************************/
-
#ifndef __com_sun_star_beans_Pair_idl__
#define __com_sun_star_beans_Pair_idl__
+
+//=============================================================================
+
module com { module sun { module star { module beans {
//=============================================================================
+
/** A tuple, or pair.
- <p>
- This structure allows for conveniently packing together two values of
- any type, and could be useful as the result type of methods.
- </p>
+ <p> This structure allows for conveniently packing together two values of
+ any type, and could be useful as the result type of methods.</p>
- @since OpenOffice 3.0
+ @since OpenOffice 3.0
*/
-published struct Pair<T, U> {
+published struct Pair<T, U>
+{
+ //-------------------------------------------------------------------------
+
+ // first object
+ T First;
+
+ // second object
+ U Second;
- /// first object.
- T First;
+ //-------------------------------------------------------------------------
- /// second object.
- U Second;
};
//=============================================================================
Modified: openoffice/trunk/main/udkapi/com/sun/star/beans/Property.idl
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/udkapi/com/sun/star/beans/Property.idl?rev=1850050&r1=1850049&r2=1850050&view=diff
==============================================================================
--- openoffice/trunk/main/udkapi/com/sun/star/beans/Property.idl (original)
+++ openoffice/trunk/main/udkapi/com/sun/star/beans/Property.idl Mon Dec 31 14:38:35 2018
@@ -1,5 +1,5 @@
/**************************************************************
- *
+ *
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -7,36 +7,35 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- *
+ *
*************************************************************/
-#ifndef __com_sun_star_beans_Property_idl__
-#define __com_sun_star_beans_Property_idl__
-
-#ifndef __com_sun_star_reflection_XIdlClass_idl__
-#include <com/sun/star/reflection/XIdlClass.idl>
-#endif
-
-
-//=============================================================================
-
-module com { module sun { module star { module beans {
-
-//=============================================================================
-
+#ifndef __com_sun_star_beans_Property_idl__
+#define __com_sun_star_beans_Property_idl__
+
+#ifndef __com_sun_star_reflection_XIdlClass_idl__
+#include <com/sun/star/reflection/XIdlClass.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module beans {
+
+//=============================================================================
+
/** This structure describes a property.
-
-
+
<dl>There are three types of properties:
<dt>- bound properties</dt>
<dt>- constrained properties</dt>
@@ -45,44 +44,47 @@ module com { module sun { module star
*/
published struct Property
{
+ //-------------------------------------------------------------------------
+
/** specifies the name of the property.
-
- <p>The name is unique within an <type>XPropertySet</type>.
- Upper and lower case are distinguished.</p>
+
+ <p> The name is unique within an <type>XPropertySet</type>.
+ Upper and lower case are distinguished.</p>
*/
- string Name;
-
- //-------------------------------------------------------------------------
-
+ string Name;
+
+ //-------------------------------------------------------------------------
+
/** contains an implementation-specific handle for the property.
-
- <p>It may be -1 if the implementation has no handle. You can use
- this handle to get values from the <type>XFastPropertySet</type>.</p>
+
+ <p> It may be -1 if the implementation has no handle. You can use
+ this handle to get values from the <type>XFastPropertySet</type>.</p>
*/
- long Handle;
-
- //-------------------------------------------------------------------------
-
- /** contains an object that identifies the declared type for
- the property.
-
- <p>If the property has multiple types or the type is not
- known, <strong>but not an <atom>any</atom></strong>, then
- <const>void</const> must be returned.</p>
+ long Handle;
+
+ //-------------------------------------------------------------------------
+
+ /** contains an object that identifies the declared type for the property.
+
+ <p> If the property has multiple types or the type is not
+ known, <strong>but not an <atom>any</atom></strong>, then
+ <const>void</const> must be returned.</p>
*/
- type Type;
-
- //-------------------------------------------------------------------------
-
+ type Type;
+
+ //-------------------------------------------------------------------------
+
/** This field may contain zero or more constants of the
<type>PropertyAttribute</type> constants group.
*/
- short Attributes;
-
-};
-
-//=============================================================================
-
-}; }; }; };
-
-#endif
+ short Attributes;
+
+ //-------------------------------------------------------------------------
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
Modified: openoffice/trunk/main/udkapi/com/sun/star/beans/StringPair.idl
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/udkapi/com/sun/star/beans/StringPair.idl?rev=1850050&r1=1850049&r2=1850050&view=diff
==============================================================================
--- openoffice/trunk/main/udkapi/com/sun/star/beans/StringPair.idl (original)
+++ openoffice/trunk/main/udkapi/com/sun/star/beans/StringPair.idl Mon Dec 31 14:38:35 2018
@@ -1,5 +1,5 @@
/**************************************************************
- *
+ *
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -7,25 +7,26 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- *
+ *
*************************************************************/
#ifndef __com_sun_star_beans_StringPair_idl__
#define __com_sun_star_beans_StringPair_idl__
+
//=============================================================================
- module com { module sun { module star { module beans {
+module com { module sun { module star { module beans {
//=============================================================================
@@ -33,6 +34,8 @@
*/
published struct StringPair
{
+ //-------------------------------------------------------------------------
+
/** specifies the first of the two strings.
*/
string First;
@@ -42,6 +45,9 @@ published struct StringPair
/** specifies the second of the two strings.
*/
string Second;
+
+ //-------------------------------------------------------------------------
+
};
//=============================================================================
Modified: openoffice/trunk/main/udkapi/com/sun/star/beans/XExactName.idl
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/udkapi/com/sun/star/beans/XExactName.idl?rev=1850050&r1=1850049&r2=1850050&view=diff
==============================================================================
--- openoffice/trunk/main/udkapi/com/sun/star/beans/XExactName.idl (original)
+++ openoffice/trunk/main/udkapi/com/sun/star/beans/XExactName.idl Mon Dec 31 14:38:35 2018
@@ -1,5 +1,5 @@
/**************************************************************
- *
+ *
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -7,63 +7,65 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- *
+ *
*************************************************************/
-#ifndef __com_sun_star_beans_XExactName_idl__
-#define __com_sun_star_beans_XExactName_idl__
-
-#ifndef __com_sun_star_uno_XInterface_idl__
-#include <com/sun/star/uno/XInterface.idl>
-#endif
-
-
-//=============================================================================
-
-module com { module sun { module star { module beans {
-
-//=============================================================================
-
-/** provides a method of changing names for converting
- an approximate name to an existing name.
-
+#ifndef __com_sun_star_beans_XExactName_idl__
+#define __com_sun_star_beans_XExactName_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module beans {
+
+//=============================================================================
+
+/** provides a method of changing names for converting
+ an approximate name to an existing name.
+
<p> One field of application is the conversion of case-insensitive
- names to the existing names. </p>
+ names to the existing names.</p>
- <p>Example: A basic interpreter ignores the case of the names. So
- it must query the <type>XExactName</type> interface and then call
- the method. </p>
+ <p> Example: A basic interpreter ignores the case of the names. So
+ it must query the <type>XExactName</type> interface and then call
+ the method.</p>
- @see com::sun::star::beans::XPropertySet
- @see com::sun::star::beans::XIntrospectionAccess
+ @see com::sun::star::beans::XPropertySet
+ @see com::sun::star::beans::XIntrospectionAccess
@see com::sun::star::container::XNameAccess
*/
published interface XExactName: com::sun::star::uno::XInterface
-{
- //-------------------------------------------------------------------------
-
- /** @returns
- the exact name for a given aprroximate name.
-
- <p>For example "getExactName" could be returned for "GETEXACTNAME"
- when "GETEXACTNAME" was used by a case insesitive scripting language. </p>
+{
+ //-------------------------------------------------------------------------
+
+ /** @returns
+ the exact name for a given approximate name.
+
+ <p> For example "getExactName" could be returned for "GETEXACTNAME"
+ when "GETEXACTNAME" was used by a case insensitive scripting language.</p>
*/
- string getExactName( [in] string aApproximateName );
-
-};
-
-//=============================================================================
-
-}; }; }; };
-
-#endif
+ string getExactName( [in] string aApproximateName );
+
+ //-------------------------------------------------------------------------
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
Modified: openoffice/trunk/main/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl?rev=1850050&r1=1850049&r2=1850050&view=diff
==============================================================================
--- openoffice/trunk/main/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl (original)
+++ openoffice/trunk/main/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl Mon Dec 31 14:38:35 2018
@@ -1,5 +1,5 @@
/**************************************************************
- *
+ *
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -7,165 +7,167 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- *
+ *
*************************************************************/
-#ifndef __com_sun_star_beans_XHierarchicalPropertySet_idl__
-#define __com_sun_star_beans_XHierarchicalPropertySet_idl__
-
-#ifndef __com_sun_star_uno_XInterface_idl__
-#include <com/sun/star/uno/XInterface.idl>
-#endif
-
-#ifndef __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
-#include <com/sun/star/beans/XHierarchicalPropertySetInfo.idl>
-#endif
-
-#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
-#include <com/sun/star/beans/UnknownPropertyException.idl>
-#endif
-
-#ifndef __com_sun_star_beans_PropertyVetoException_idl__
-#include <com/sun/star/beans/PropertyVetoException.idl>
-#endif
-
-#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
-#include <com/sun/star/lang/IllegalArgumentException.idl>
-#endif
-
-#ifndef __com_sun_star_lang_WrappedTargetException_idl__
-#include <com/sun/star/lang/WrappedTargetException.idl>
-#endif
-
-
-//=============================================================================
-
-module com { module sun { module star { module beans {
-
-//=============================================================================
-
+#ifndef __com_sun_star_beans_XHierarchicalPropertySet_idl__
+#define __com_sun_star_beans_XHierarchicalPropertySet_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
+#include <com/sun/star/beans/XHierarchicalPropertySetInfo.idl>
+#endif
+
+#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
+#include <com/sun/star/beans/UnknownPropertyException.idl>
+#endif
+
+#ifndef __com_sun_star_beans_PropertyVetoException_idl__
+#include <com/sun/star/beans/PropertyVetoException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_WrappedTargetException_idl__
+#include <com/sun/star/lang/WrappedTargetException.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module beans {
+
+//=============================================================================
+
/** provides information about and access to the
- a hierarchy of properties from an implementation.
-
+ a hierarchy of properties from an implementation.
+
<p> Usually an object that implements this interface
- also implements <type>XPropertySet</type> and at
- least some of the properties have subproperties. </p>
+ also implements <type>XPropertySet</type> and at
+ least some of the properties have subproperties.</p>
<p> This interface allows direct access to subsubproperties, ...
- up to an arbitrary nesting depth. Often the intermediate
- elements of the hierarchy implement <type>XProperty</type>. </p>
+ up to an arbitrary nesting depth. Often the intermediate
+ elements of the hierarchy implement <type>XProperty</type>.</p>
- <p> Each implementation specifies how the
- hierarchical property names, that are
- used to access the elements of the hierarchy,
- are formed. </p>
+ <p> Each implementation specifies how the
+ hierarchical property names, that are
+ used to access the elements of the hierarchy,
+ are formed.</p>
<p> Commonly a notation similar to filesystem paths
(separated by '/' slashes) or nested module names
- (separated by dots '.' or '::') is used. </p>
-
+ (separated by dots '.' or '::') is used.</p>
+
*/
published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
-{
- //-------------------------------------------------------------------------
-
+{
+ //-------------------------------------------------------------------------
+
/** retrieve information about the hierarchy of properties
- @returns
- the <type>XHierarchicalPropertySetInfo</type> interface,
- which describes the property hierarchy of the object which
- supplies this interface.
-
- @returns
- <NULL/> if the implementation cannot or will
- not provide information about the properties; otherwise the
- interface <type>XHierarchicalPropertySetInfo</type> is returned.
+ @returns
+ the <type>XHierarchicalPropertySetInfo</type> interface,
+ which describes the property hierarchy of the object which
+ supplies this interface.
+
+ @returns
+ <NULL/> if the implementation cannot or will
+ not provide information about the properties; otherwise the
+ interface <type>XHierarchicalPropertySetInfo</type> is returned.
*/
- com::sun::star::beans::XHierarchicalPropertySetInfo
- getHierarchicalPropertySetInfo();
-
- //-------------------------------------------------------------------------
-
+ com::sun::star::beans::XHierarchicalPropertySetInfo
+ getHierarchicalPropertySetInfo();
+
+ //-------------------------------------------------------------------------
+
/** sets the value of the property with the specified nested name.
-
- @param aHierarchicalPropertyName
- This parameter specifies the name of the property.
-
- @param aValue
- This parameter specifies the new value for the property.
-
- @throws UnknownPropertyException
- if the property does not exist.
-
- @throws PropertyVetoException
- if the property is constrained and the change is vetoed by a
+
+ @param aHierarchicalPropertyName
+ This parameter specifies the name of the property.
+
+ @param aValue
+ This parameter specifies the new value for the property.
+
+ @throws UnknownPropertyException
+ if the property does not exist.
+
+ @throws PropertyVetoException
+ if the property is constrained and the change is vetoed by a
<type>XVetoableChangeListener</type>.
-
- @throws com::sun::star::uno::lang::IllegalArgumentException
- if <var>aValue</var> is not a legal value for this property or
- if <var>aHierarchicalPropertyName</var> is not a well-formed
- nested name for this hierarchy.
+
+ @throws com::sun::star::uno::lang::IllegalArgumentException
+ if <var>aValue</var> is not a legal value for this property or
+ if <var>aHierarchicalPropertyName</var> is not a well-formed
+ nested name for this hierarchy.
An implementation is not required to detect the latter condition.
- @throws com::sun::star::lang::WrappedTargetException
- if the implementation has an internal reason for the exception.
- In this case the original exception is wrapped into that
+ @throws com::sun::star::lang::WrappedTargetException
+ if the implementation has an internal reason for the exception.
+ In this case the original exception is wrapped into that
<type scope="com::sun::star::lang">WrappedTargetException</type>.
-
+
@see XPropertySet::setPropertyValue
*/
- void setHierarchicalPropertyValue( [in] string aHierarchicalPropertyName,
- [in] any aValue )
- raises( com::sun::star::beans::UnknownPropertyException,
- com::sun::star::beans::PropertyVetoException,
- com::sun::star::lang::IllegalArgumentException,
- com::sun::star::lang::WrappedTargetException );
-
- //-------------------------------------------------------------------------
-
- /** @returns
- the value of the property with the specified nested name.
-
- @param aHierarchicalPropertyName
- This parameter specifies the name of the property.
-
- @throws UnknownPropertyException
- if the property does not exist.
-
- @throws com::sun::star::uno::lang::IllegalArgumentException
- if <var>aHierarchicalPropertyName</var> is not a well-formed
+ void setHierarchicalPropertyValue( [in] string aHierarchicalPropertyName,
+ [in] any aValue )
+ raises( com::sun::star::beans::UnknownPropertyException,
+ com::sun::star::beans::PropertyVetoException,
+ com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::lang::WrappedTargetException );
+
+ //-------------------------------------------------------------------------
+
+ /** gets the value of the property with the specified nested name.
+
+ @returns
+ the value of the property with the specified nested name.
+
+ @param aHierarchicalPropertyName
+ This parameter specifies the name of the property.
+
+ @throws UnknownPropertyException
+ if the property does not exist.
+
+ @throws com::sun::star::uno::lang::IllegalArgumentException
+ if <var>aHierarchicalPropertyName</var> is not a well-formed
nested name for this hierarchy.
- An implementation is not required to detect this
+ An implementation is not required to detect this
condition.
- @throws com::sun::star::lang::WrappedTargetException
- if the implementation has an internal reason for the exception.
- In this case the original exception is wrapped into that
+ @throws com::sun::star::lang::WrappedTargetException
+ if the implementation has an internal reason for the exception.
+ In this case the original exception is wrapped into that
<type scope="com::sun::star::lang">WrappedTargetException</type>.
-
+
@see XPropertySet::getPropertyValue
*/
- any getHierarchicalPropertyValue( [in] string aHierarchicalPropertyName )
- raises( com::sun::star::beans::UnknownPropertyException,
- com::sun::star::lang::IllegalArgumentException,
- com::sun::star::lang::WrappedTargetException );
-
- //-------------------------------------------------------------------------
-
-};
-
-//=============================================================================
-
-}; }; }; };
-
-#endif
+ any getHierarchicalPropertyValue( [in] string aHierarchicalPropertyName )
+ raises( com::sun::star::beans::UnknownPropertyException,
+ com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::lang::WrappedTargetException );
+
+ //-------------------------------------------------------------------------
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif