offapi/com/sun/star/document/LockedDocumentRequest.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: LockedDocumentRequest.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_document_LockedDocumentRequest_idl__
  31 #define __com_sun_star_document_LockedDocumentRequest_idl__
  32
  33 #ifndef __com_sun_star_uno_Exception_idl__
  34 #include <com/sun/star/uno/Exception.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_XModel_idl__
  42 #include <com/sun/star/frame/XModel.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module document {
  48
  49 //=============================================================================
  50 /** Is used for interaction handle to query user decision regarding locked document.
  51
  52     @since OOo 3.0
  53 */
  54 published exception LockedDocumentRequest : ::com::sun::star::uno::Exception
  55 {
  56     /** The URL of the locked document.
  57      */
  58     string DocumentURL;
  59
  60     /** The user information of the locked document.
  61      */
  62     string UserInfo;
  63
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 #endif
  71