offapi/com/sun/star/awt/XPatternField.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: XPatternField.idl,v $
  10  * $Revision: 1.12 $
  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_awt_XPatternField_idl__
  31 #define __com_sun_star_awt_XPatternField_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** gives access to the value and formatting of a pattern field.
  45  */
  46 published interface XPatternField: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** sets the pattern mask.
  51      */
  52     [oneway] void setMasks( [in] string EditMask,
  53              [in] string LiteralMask );
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** returns the currently set pattern mask.
  58      */
  59     void getMasks( [out] string EditMask,
  60              [out] string LiteralMask );
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** sets the string value of the pattern field.
  65      */
  66     [oneway] void setString( [in] string Str );
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** returns the currently set string value of the pattern field.
  71      */
  72     string getString();
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** determines if the format is checked during user input.
  77      */
  78     [oneway] void setStrictFormat( [in] boolean bStrict );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** returns whether the format is currently checked during user input.
  83      */
  84     boolean isStrictFormat();
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif