summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/view/XSelectionSupplier.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/view/XSelectionSupplier.idl70
1 files changed, 70 insertions, 0 deletions
diff --git a/offapi/com/sun/star/view/XSelectionSupplier.idl b/offapi/com/sun/star/view/XSelectionSupplier.idl
new file mode 100644
index 000000000..b4d0efa2e
--- /dev/null
+++ b/offapi/com/sun/star/view/XSelectionSupplier.idl
@@ -0,0 +1,70 @@
+/* -*- 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_view_XSelectionSupplier_idl__
+#define __com_sun_star_view_XSelectionSupplier_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+#include <com/sun/star/view/XSelectionChangeListener.idl>
+
+
+
+module com { module sun { module star { module view {
+
+
+/** makes it possible to access and change the selection in a view.
+
+ @see OfficeDocumentView
+ */
+published interface XSelectionSupplier: com::sun::star::uno::XInterface
+{
+ /** selects the object represented by <var>xSelection</var> if it is
+ known and selectable in this object.
+ */
+ boolean select( [in] any xSelection )
+ raises( com::sun::star::lang::IllegalArgumentException );
+
+ /** @returns
+ the current selection.
+
+ <p>The selection is either specified by an object which is contained
+ in the component to which the view belongs, or it is an interface of a
+ collection which contains such objects.
+ */
+ any getSelection();
+
+ /** registers an event listener, which is called when the selection changes.
+ */
+ void addSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
+
+ /** unregisters an event listener which was registered with
+ XSelectionSupplier::addSelectionChangeListener().
+ */
+ void removeSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */