offapi/com/sun/star/task/DocumentPasswordRequest.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: DocumentPasswordRequest.idl,v $
  10  * $Revision: 1.8 $
  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_task_DocumentPasswordRequest_idl__
  31 #define __com_sun_star_task_DocumentPasswordRequest_idl__
  32
  33 #ifndef __com_sun_star_task_PasswordRequest_idl__
  34 #include <com/sun/star/task/PasswordRequest.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module task {
  41
  42 //=============================================================================
  43 /** this request specifies the mode in wich the password should be asked
  44
  45     <P>
  46     It is supported by <type>InteractionHandler</type> service, and can
  47     be used to interact for a document password. Continuations for using with
  48     the mentioned service are Abort and Approve.
  49     </P>
  50
  51     @since OOo 1.1.2
  52 */
  53 published exception DocumentPasswordRequest: PasswordRequest
  54 {
  55     //-------------------------------------------------------------------------
  56     /** the name of the document
  57     */
  58     string Name;
  59
  60 };
  61
  62 //=============================================================================
  63
  64 }; }; }; };
  65
  66 #endif