summaryrefslogtreecommitdiffstats
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.idl75
1 files changed, 75 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 000000000..62a34bf4f
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XContentAccess.idl
@@ -0,0 +1,75 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 regarding copyright
+ * ownership. The ASF licenses this file 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 .
+ */
+#ifndef __com_sun_star_ucb_XContentAccess_idl__
+#define __com_sun_star_ucb_XContentAccess_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+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 XContents,
+ 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
+ @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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */