offapi/com/sun/star/view/XSelectionSupplier.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module view {
  23
  24
  25 /** makes it possible to access and change the selection in a view.
  26
  27     @see OfficeDocumentView
  28  */
  29 published interface XSelectionSupplier: com::sun::star::uno::XInterface
  30 {
  31     /** selects the object represented by <var>xSelection</var> if it is
  32         known and selectable in this object.
  33      */
  34     boolean select( [in] any xSelection )
  35             raises( com::sun::star::lang::IllegalArgumentException );
  36
  37     /** @returns
  38                 the current selection.
  39
  40         <p>The selection is either specified by an object which is contained
  41         in the component to which the view belongs, or it is an interface of a
  42         collection which contains such objects.
  43      */
  44     any getSelection();
  45
  46     /** registers an event listener, which is called when the selection changes.
  47      */
  48     void addSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
  49
  50     /** unregisters an event listener which was registered with
  51         XSelectionSupplier::addSelectionChangeListener().
  52      */
  53     void removeSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
  54
  55 };
  56
  57
  58 }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */