dbaccess/source/ui/dlg/datasourceui.hxx

   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: datasourceui.hxx,v $
  10  * $Revision: 1.3.68.1 $
  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
  31 #ifndef DBACCESS_DATASOURCEUI_HXX
  32 #define DBACCESS_DATASOURCEUI_HXX
  33
  34 #include "dsntypes.hxx"
  35 #include "dsmeta.hxx"
  36
  37 /** === begin UNO includes === **/
  38 /** === end UNO includes === **/
  39
  40 #include <boost/shared_ptr.hpp>
  41
  42 //........................................................................
  43 namespace dbaui
  44 {
  45 //........................................................................
  46
  47     //====================================================================
  48     //= DataSourceUI
  49     //====================================================================
  50     /** encapsulates information about available UI features of a data source type
  51     */
  52     class DataSourceUI
  53     {
  54     public:
  55         DataSourceUI( const DataSourceMetaData& _rDSMeta );
  56         ~DataSourceUI();
  57
  58         /** returns whether the data source's UI contains the specified setting
  59
  60             Note that at the moment, not all items are supported by this method. In particular, use
  61             it for the following only
  62             <ul><li>All items which refer to advanced settings (see AdvancedSettingsSupport)</li>
  63             </ul>
  64
  65             A complete support of *all* items is a medium-term goal.
  66
  67             @param _nItemId
  68                 the UI's item ID for the setting in question. See dsitems.hxx.
  69         */
  70         bool    hasSetting( const USHORT _nItemId ) const;
  71
  72     private:
  73         DataSourceMetaData  m_aDSMeta;
  74     };
  75
  76 //........................................................................
  77 } // namespace dbaui
  78 //........................................................................
  79
  80 #endif // DBACCESS_DATASOURCEUI_HXX