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