summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XContentAccess.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ucb/XContentAccess.idl')
-rw-r--r--offapi/com/sun/star/ucb/XContentAccess.idl90
1 files changed, 90 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XContentAccess.idl b/offapi/com/sun/star/ucb/XContentAccess.idl
new file mode 100644
index 000000000000..8ead478e660f
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XContentAccess.idl
@@ -0,0 +1,90 @@
+/*************************************************************************
+ *
+ * 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_ucb_XContentAccess_idl__
+#define __com_sun_star_ucb_XContentAccess_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+ published interface XContent;
+ published interface XContentIdentifier;
+
+//=============================================================================
+/** specifies methods for obtaining information on a content in different
+ levels.
+
+ <p>For example, if there is a cursor which points to <type>XContent</type>s,
+ this interface could be used to give the user access to the content under
+ the cursor. If the client only needs the identifier string of the content,
+ there is no need to first create the content object, then to obtain the
+ string from it and after that to release the content.
+
+ @version 1.0
+ @author Kai Sommerfeld
+ @see XContent
+ @see XContentIdentifier
+*/
+
+published interface XContentAccess : com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /** returns the identifier string of the content ( "cheap method" ).
+
+ <p>Note that this string can be used later to recreate the content.
+
+ @returns
+ the identifier string.
+ */
+ string queryContentIdentifierString();
+
+ //-------------------------------------------------------------------------
+ /** returns the identifier object of the content.
+
+ @returns
+ the identifier object.
+ */
+ XContentIdentifier queryContentIdentifier();
+
+ //-------------------------------------------------------------------------
+ /** returns the content ( "most expensive method" ).
+
+ @returns
+ the content.
+ */
+ XContent queryContent();
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif