offapi/com/sun/star/sdbc/DriverPropertyInfo.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbc_DriverPropertyInfo_idl__
  20 #define __com_sun_star_sdbc_DriverPropertyInfo_idl__
  21
  22  module com {  module sun {  module star {  module sdbc {
  23
  24
  25 /** describes the driver properties for making a connection.
  26
  27
  28     <p>
  29     The DriverPropertyInfo is of interest only to advanced programmers
  30     who need to interact with a driver to discover and supply properties
  31     for connections.
  32     </p>
  33  */
  34 published struct DriverPropertyInfo
  35 {
  36     /** is the name of the property.
  37      */
  38     string Name;
  39
  40
  41     /** is a brief description of the property, which may be null.
  42      */
  43     string Description;
  44
  45
  46     /** is
  47         `TRUE`
  48         if a value must be supplied for this property
  49         during
  50         <code>Driver.connect</code>
  51         and
  52         `FALSE`
  53         otherwise.
  54      */
  55     boolean IsRequired;
  56
  57
  58     /** specifies the current value of the property,
  59         based on the driver-supplied default values.  This field
  60         may be empty if no value is known.
  61      */
  62     string Value;
  63
  64
  65     /** contains a sequence of possible values if the value for the field
  66             <code>DriverPropertyInfo.value</code>
  67             may be selected
  68             from a particular set of values; otherwise empty.
  69      */
  70     sequence<string> Choices;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /*===========================================================================
  77 ===========================================================================*/
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */