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