offapi/com/sun/star/ucb/OpenCommandArgument.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 #ifndef __com_sun_star_ucb_OpenCommandArgument_idl__
  20 #define __com_sun_star_ucb_OpenCommandArgument_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/Property.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** The argument for commands like "open", "update", and "synchronize".
  29
  30     @see XCommandProcessor
  31 */
  32 published struct OpenCommandArgument
  33 {
  34     /** A mode.
  35
  36         <p>The value can be one of the OpenMode constants.
  37     */
  38     long Mode;
  39
  40     /** The command's priority, in the range <code>0</code> (highest) to
  41         <code>65535</code> (lowest).
  42     */
  43     long Priority;
  44
  45     /** The data sink to write the contents into (supporting either
  46         com::sun::star::io::XActiveDataSink,
  47         com::sun::star::io::XOutputStream or
  48         com::sun::star::io::XActiveDataStreamer).
  49
  50         <p>XActiveDataSink and XOutputStream give the caller read-only
  51         access to the contents. XActiveDataStreamer offers both read and
  52         write access to the contents.
  53
  54         <p>If an XActiveDataSink is supplied, the implementation of the command
  55         needs to provide an implementation of an object implementing the
  56         interface com::sun::star::io::XInputStream. It is
  57         highly recommended that this object also implements the interface
  58         com::sun::star::io::XSeekable, if this can be done
  59         without wasting resources (i.e. allocating huge memory buffers).
  60         The implementation object has to be supplied to the data sink.
  61     */
  62     com::sun::star::uno::XInterface Sink;
  63
  64     /** The properties, for that the values shall be provided by the
  65         DynamicResultSet returned by the command).
  66     */
  67     sequence< com::sun::star::beans::Property > Properties;
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */