dbaccess/source/ui/inc/imageprovider.hxx

   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
  20 #pragma once
  21
  22 #include <com/sun/star/graphic/XGraphic.hpp>
  23 #include <com/sun/star/sdbc/XConnection.hpp>
  24
  25 #include <memory>
  26
  27 namespace dbaui
  28 {
  29     // ImageProvider
  30     struct ImageProvider_Data;
  31     /** provides images for database objects such as tables, queries, forms, reports ...
  32
  33         At the moment, this class cares for small icons only, that is, icons which can be used
  34         in a tree control. On the medium term, we should extend it with support for different-sized
  35         icons.
  36     */
  37     class ImageProvider
  38     {
  39     private:
  40         std::shared_ptr< ImageProvider_Data >   m_pData;
  41
  42     public:
  43         /** creates a semi-functional ImageProvider instance
  44
  45             The resulting instance is not able to provide any concrete object images,
  46             but only default images.
  47         */
  48         ImageProvider();
  49
  50         /** creates an ImageProvider instance
  51
  52             @param  _rxConnection
  53                 denotes the connection to work for. Must not be <NULL/>.
  54         */
  55         ImageProvider(
  56             const css::uno::Reference< css::sdbc::XConnection >& _rxConnection
  57         );
  58
  59         /** returns the image to be used for a database object with the given name
  60
  61             @param  _nDatabaseObjectType
  62                 the type of the object. Must be one of the css.sdb.application.DatabaseObject
  63                 constants.
  64             @param  _rName
  65                 the name of the object
  66             @return
  67                 the name of the image to be used for the object.
  68         */
  69         OUString getImageId(
  70             const OUString& _rName,
  71             const sal_Int32 _nDatabaseObjectType
  72         );
  73
  74         // check whether the connection can give us an icon
  75         css::uno::Reference<css::graphic::XGraphic> getXGraphic(const OUString& _rName,
  76                                                                 const sal_Int32 _nDatabaseObjectType);
  77
  78         /** returns the resource ID for the default image to be used for a database object
  79
  80             In opposite to getImageId, this method does not check the concrete object
  81             for its image, but returns a default image to be used for all objects of the given
  82             type.
  83
  84             @param  _nDatabaseObjectType
  85                 the type of the object. Must be one of the css.sdb.application.DatabaseObject
  86                 constants.
  87             @return
  88                 the resource image name to be used for the object type.
  89         */
  90         static OUString getDefaultImageResourceID(sal_Int32 _nDatabaseObjectType);
  91
  92         static OUString getFolderImageId(
  93             sal_Int32 _nDatabaseObjectType
  94         );
  95
  96         /** retrieves the image to be used for a database as a whole.
  97             @return
  98                 the image to be used for folders of this type
  99         */
 100         static OUString getDatabaseImage();
 101     };
 102
 103 } // namespace dbaui
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */