offapi/com/sun/star/ucb/CheckinArgument.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 #ifndef __com_sun_star_ucb_CheckinArgument_idl__
  10 #define __com_sun_star_ucb_CheckinArgument_idl__
  11
  12
  13
  14 module com { module sun { module star { module ucb {
  15
  16 /** contains information needed to checkin a document.
  17
  18     <p>The checkin command is always called on the target private
  19     working copy document.</p>
  20 */
  21 struct CheckinArgument
  22 {
  23     /** Tells whether to create a new major or minor version during the
  24         checkin.
  25     */
  26     boolean MajorVersion;
  27
  28     /** Contains the version comment to set during the checkin.
  29     */
  30     string VersionComment;
  31
  32     /** contains the URL of the source of the action (e.g. the URL of
  33         the temporary file to checkin).
  34     */
  35     string SourceURL;
  36
  37     /** contains the URL of the private working copy to checkin.
  38     */
  39     string TargetURL;
  40
  41     /** contains the title of the transferred object, if it is different
  42         from the original one.
  43
  44         <p>If this field is filled, for example, a file will be renamed
  45         while it is being checked in.</p>
  46     */
  47     string NewTitle;
  48
  49     /** contains the Mime-Type of the content to check-in as it may be
  50         different from the original one.
  51     */
  52     string MimeType;
  53 };
  54
  55
  56 }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */