offapi/com/sun/star/ucb/XCommandEnvironment.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 module com { module sun { module star { module ucb {
  22
  23 /** defines the environment for a command.
  24
  25     @version  1.0
  26     @see XCommandProcessor
  27 */
  28 published interface XCommandEnvironment : com::sun::star::uno::XInterface
  29 {
  30     /** returns the command's interaction handler.
  31
  32         <p>If called multiple times, this method should consistently return the
  33         same value (to allow caching).
  34
  35         @returns
  36         an interaction handler
  37     */
  38     com::sun::star::task::XInteractionHandler getInteractionHandler();
  39
  40     /** returns the command's progress handler.
  41
  42         <p>If called multiple times, this method should consistently return the
  43         same value (to allow caching).
  44
  45         @returns
  46         a progress handler
  47     */
  48     com::sun::star::ucb::XProgressHandler getProgressHandler();
  49 };
  50
  51
  52 }; }; }; };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */