offapi/com/sun/star/task/XInteractionPassword.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: XInteractionPassword.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_XInteractionPassword_idl__
  31 #define __com_sun_star_task_XInteractionPassword_idl__
  32
  33 #ifndef __com_sun_star_task_XInteractionContinuation_idl__
  34 #include <com/sun/star/task/XInteractionContinuation.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module task {
  40
  41 //=============================================================================
  42 /** A continuation to get a password from interaction helper.
  43
  44     @since OOo 1.1.2
  45 */
  46 published interface XInteractionPassword : ::com::sun::star::task::XInteractionContinuation
  47 {
  48     //-------------------------------------------------------------------------
  49     /** Store result password to the continuation.
  50
  51         @param aPasswd the result password.
  52
  53     */
  54     void   setPassword( [in] string aPasswd );
  55
  56     //-------------------------------------------------------------------------
  57     /** Get result password from the continuation.
  58
  59         @returns       the stored password.
  60     */
  61     string getPassword();
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 #endif
  69