summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorJens-Heiner Rechtien <hr@openoffice.org>2007-08-03 12:50:43 +0000
committerJens-Heiner Rechtien <hr@openoffice.org>2007-08-03 12:50:43 +0000
commit105188a853d65637670a8f9da310ef674e37b4b2 (patch)
treea8ad2e6fa3f25b6a1f8f80e18280ef30e81fe56f /offapi
parent1f39729c26363bfd615f33e930655cab22b15cda (diff)
INTEGRATION: CWS hcicons (1.3.214); FILE MERGED
2007/04/18 07:22:07 fs 1.3.214.1: #i76228# buttons now also support an ImageURL
Diffstat (limited to 'offapi')
-rw-r--r--offapi/com/sun/star/inspection/LineDescriptor.idl79
1 files changed, 58 insertions, 21 deletions
diff --git a/offapi/com/sun/star/inspection/LineDescriptor.idl b/offapi/com/sun/star/inspection/LineDescriptor.idl
index 92777b5d7..e24e59ea3 100644
--- a/offapi/com/sun/star/inspection/LineDescriptor.idl
+++ b/offapi/com/sun/star/inspection/LineDescriptor.idl
@@ -4,9 +4,9 @@
*
* $RCSfile: LineDescriptor.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: vg $ $Date: 2006-03-31 12:02:17 $
+ * last change: $Author: hr $ $Date: 2007-08-03 13:50:43 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
@@ -82,21 +82,15 @@ struct LineDescriptor
/** detetrmines whether a button exists which can be used for a more complex, interactive
property value input.
- @see XPropertyHandler::onInteractivePropertySelection
- @see HasSecondaryButton
- */
- boolean HasPrimaryButton;
-
- /** detetrmines whether a secondary button exists which can be used for a more complex, interactive
- property value input.
-
- <p>A secondary button subordinated to the primary button. If no primary button exists
- (<member>HasPrimaryButton</member>), this member is ignored.</p>
+ <p>If no image for the primary button is specified, but a primary button is present,
+ the three dots will be displayed on the button.</p>
@see XPropertyHandler::onInteractivePropertySelection
@see HasSecondaryButton
+ @see PrimaryButtonImageURL
+ @see PrimaryButtonImage
*/
- boolean HasSecondaryButton;
+ boolean HasPrimaryButton;
/** describes a unique id to associate with the primary button
@@ -110,6 +104,42 @@ struct LineDescriptor
*/
long PrimaryButtonId;
+ /** describes the URL of an image to display on the primary button, if any.
+
+ <p>This URL will be used to obtain an actual <type scope="com::sun::star::graphic">XGraphic</type>
+ object from an <type scope="com::sun::star::graphic">GraphicProvider</type>.</p>
+
+ <p>The property will be ignored if <member>HasPrimaryButton</member> is <FALSE/>.</p>
+
+ <p>If you need to specify a graphic which does not have an URL, but is available as
+ <type scope="com::sun::star::graphic">XGraphic</type> only, then you must leave
+ <code>PrimaryButtonImageURL</code> empty, and use the <member>PrimaryButtonImage</member> property.
+
+ @see PrimaryButtonImage
+ */
+ string PrimaryButtonImageURL;
+
+ /** describes a graphics to display at the primary button, if any.
+
+ <p>The property will be ignored if <member>HasPrimaryButton</member> is <FALSE/>, or
+ if <member>PrimaryButtonImageURL</member> is a non-empty string.</p>
+
+ @see HasPrimaryButton
+ @see PrimaryButtonImageURL
+ */
+ com::sun::star::graphic::XGraphic PrimaryButtonImage;
+
+ /** detetrmines whether a secondary button exists which can be used for a more complex, interactive
+ property value input.
+
+ <p>A secondary button subordinated to the primary button. If no primary button exists
+ (<member>HasPrimaryButton</member>), this member is ignored.</p>
+
+ @see XPropertyHandler::onInteractivePropertySelection
+ @see HasSecondaryButton
+ */
+ boolean HasSecondaryButton;
+
/** describes a unique id to associate with the primary button
<p>If a secondary button exists for a property's UI representation (<member>HasSecondaryButton</member>),
@@ -119,21 +149,28 @@ struct LineDescriptor
*/
long SecondaryButtonId;
- /** describes a graphics to display at the primary button, if any.
+ /** describes the URL of an image to display on the secondary button, if any.
- <p>If no image for the primary button is specified, but a primary button is present,
- the three dots will be displayed on the button.</p>
+ <p>This URL will be used to obtain an actual <type scope="com::sun::star::graphic">XGraphic</type>
+ object from an <type scope="com::sun::star::graphic">GraphicProvider</type>.</p>
- @see HasPrimaryButton
+ <p>The property will be ignored if <member>HasSecondaryButton</member> is <FALSE/>.</p>
+
+ <p>If you need to specify a graphic which does not have an URL, but is available as
+ <type scope="com::sun::star::graphic">XGraphic</type> only, then you must leave
+ <code>SecondaryButtonImageURL</code> empty, and use the <member>SecondaryButtonImage</member> property.
+
+ @see SecondaryButtonImage
*/
- com::sun::star::graphic::XGraphic PrimaryButtonImage;
+ string SecondaryButtonImageURL;
- /** describes a graphics to display at the primary button, if any.
+ /** describes a graphics to display at the secondary button, if any.
- <p>If no image for the secondary button is specified, but a secondary button is present,
- the three dots will be displayed on the button.</p>
+ <p>The property will be ignored if <member>HasSecondaryButton</member> is <FALSE/>, or
+ if <member>SecondaryButtonImageURL</member> is a non-empty string.</p>
@see HasSecondaryButton
+ @see SecondaryButtonImageURL
*/
com::sun::star::graphic::XGraphic SecondaryButtonImage;