dbaccess/source/ui/inc/UITools.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 #ifndef INCLUDED_DBACCESS_SOURCE_UI_INC_UITOOLS_HXX
  20 #define INCLUDED_DBACCESS_SOURCE_UI_INC_UITOOLS_HXX
  21
  22 #include <connectivity/dbexception.hxx>
  23 #include <comphelper/stl_types.hxx>
  24 #include "TypeInfo.hxx"
  25 #include <editeng/svxenum.hxx>
  26 #include <vcl/taskpanelist.hxx>
  27 #include <connectivity/dbtools.hxx>
  28
  29 #include <memory>
  30
  31 #define RET_ALL     10
  32
  33 // we only need forward decl here
  34 namespace com { namespace sun { namespace star {
  35
  36     namespace beans     { class XPropertySet;}
  37     namespace container
  38     {
  39         class XNameAccess;
  40         class XHierarchicalNameContainer;
  41     }
  42     namespace lang
  43     {
  44         class XEventListener;
  45     }
  46     namespace awt
  47     {
  48         struct FontDescriptor;
  49     }
  50     namespace sdbc
  51     {
  52         class XDatabaseMetaData;
  53         class XConnection;
  54     }
  55     namespace util
  56     {
  57         struct URL;
  58         class XNumberFormatter;
  59     }
  60     namespace ucb { class XContent; }
  61     namespace uno { class XComponentContext; }
  62
  63 }}}
  64
  65 namespace svt
  66 {
  67     class EditBrowseBox;
  68 }
  69
  70 namespace vcl { class Window; }
  71 class ToolBox;
  72 namespace vcl { class Font; }
  73 class SvNumberFormatter;
  74 class SfxFilter;
  75
  76 namespace dbaui
  77 {
  78
  79     /** creates a new connection and appends the eventlistener
  80         @param  _rsDataSourceName       name of the datasource
  81         @param  _xDatabaseContext       the database context
  82         @param  _rxContext              the UNO component context
  83         @param  _rEvtLst                the eventlistener which will be added to the new created connection
  84         @param  _rOUTConnection         this parameter will be filled with the new created connection
  85         @return SQLExceptionInfo        contains a SQLException, SQLContext or a SQLWarning when they araised else .isValid() will return false
  86     */
  87     ::dbtools::SQLExceptionInfo createConnection(
  88                                     const OUString& _rsDataSourceName,
  89                                     const css::uno::Reference< css::container::XNameAccess >& _xDatabaseContext,
  90                                     const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
  91                                     css::uno::Reference< css::lang::XEventListener>& _rEvtLst,
  92                                     css::uno::Reference< css::sdbc::XConnection>& _rOUTConnection );
  93     /** creates a new connection and appends the eventlistener
  94         @param  _xDataSource            the datasource
  95         @param  _rxContext              the UNO component context
  96         @param  _rEvtLst                the eventlistener which will be added to the new created connection
  97         @param  _rOUTConnection         this parameter will be filled with the new created connection
  98         @return SQLExceptionInfo        contains a SQLException, SQLContext or a SQLWarning when they araised else .isValid() will return false
  99     */
 100     ::dbtools::SQLExceptionInfo createConnection(
 101                                     const css::uno::Reference< css::beans::XPropertySet >& _xDataSource,
 102                                     const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
 103                                     css::uno::Reference< css::lang::XEventListener>& _rEvtLst,
 104                                     css::uno::Reference< css::sdbc::XConnection>& _rOUTConnection );
 105
 106     /**  creates a error dialog which displays the SQLExceptionInfo. Also it supports a "more" button where detailed information are available
 107         @param  _rInfo                  the error which should be shown, if the info is not valid no error dialog will appear
 108         @param  _pParent                the parent of the error dialog
 109         @param  _rxContext              need to create the dialog
 110     */
 111     void showError( const ::dbtools::SQLExceptionInfo& _rInfo,
 112                     vcl::Window* _pParent,
 113                     const css::uno::Reference< css::uno::XComponentContext >& _rxContext);
 114
 115     /** fills a map and a vector with localized type names
 116         @param  _rxConnection   the connection to access the metadata
 117         @param  _rsTypeNames    a list of localized type names separated with ';'
 118         @param  _rTypeInfoMap   the filled map with the type names
 119         @param  _rTypeInfoIters the vector filled with map iterators
 120     */
 121     void fillTypeInfo(  const css::uno::Reference< css::sdbc::XConnection>& _rxConnection,
 122                         const OUString& _rsTypeNames,
 123                         OTypeInfoMap& _rTypeInfoMap,
 124                         ::std::vector<OTypeInfoMap::iterator>& _rTypeInfoIters);
 125
 126     /** fill a column with data of a field description
 127         @param  _rxColumn   the column which should be filled
 128         @param  _pFieldDesc the source of the data
 129     */
 130     class OFieldDescription;
 131     void setColumnProperties(   const css::uno::Reference< css::beans::XPropertySet>& _rxColumn,
 132                                 const OFieldDescription* _pFieldDesc);
 133
 134     OUString createDefaultName(  const css::uno::Reference< css::sdbc::XDatabaseMetaData>& _xMetaData,
 135                                  const css::uno::Reference< css::container::XNameAccess>& _xTables,
 136                                  const OUString& _sName);
 137
 138     /** checks if the given name exists in the database context
 139     */
 140     bool checkDataSourceAvailable(  const OUString& _sDataSourceName,
 141                                     const css::uno::Reference< css::uno::XComponentContext >& _rxContext);
 142
 143     /** maps SvxCellHorJustify to css::awt::TextAlign
 144         @param SvxCellHorJustify& _eAlignment
 145         @return the corresponding css::awt::TextAlign
 146     */
 147     sal_Int32 mapTextAllign(const SvxCellHorJustify& _eAlignment);
 148
 149     /** retrieves a data source given by name or URL, and displays an error if this fails
 150
 151         Any <type scope="css::sdbc">SQLException</type>s which occur will be displayed.
 152         Additionally, and Exceptions which indicate a data source name pointing to a non-existent database
 153         URL will also be denoted. Yet more additionally, and other exceptions will be forwarded to
 154         a <type scope="css::sdb">InteractionHandler</type>.
 155
 156         @param _rDataSourceName
 157             the URL of the database document, or the name of a registered data source
 158         @param _pErrorMessageParent
 159             the window to use as parent for error messages
 160         @param _rxContext
 161             a service factory to use for components to be created
 162         @param _pErrorInfo
 163             takes the error info in case of failure. If <NULL/>, the error is displayed to the user.
 164     */
 165     css::uno::Reference< css::sdbc::XDataSource >
 166         getDataSourceByName(
 167                 const OUString& _rDataSourceName,
 168                 vcl::Window* _pErrorMessageParent,
 169                 const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
 170                 ::dbtools::SQLExceptionInfo* _pErrorInfo
 171             );
 172
 173     /** returns either the model when data source is given as parameter,
 174         or returns a data source when a model is given.
 175         @param _xObject Either a data source or a model.
 176     */
 177     css::uno::Reference< css::uno::XInterface > getDataSourceOrModel(const css::uno::Reference< css::uno::XInterface >& _xObject);
 178
 179     /** maps css::awt::TextAlign to SvxCellHorJustify
 180         @param css::awt::TextAlign& _nAlignment
 181         @return the corresponding SvxCellHorJustify
 182     */
 183     SvxCellHorJustify mapTextJustify(sal_Int32 _nAlignment);
 184
 185     /** call the format dialog and set the selected format at the column
 186         @param  _xAffectedCol   Font to be converted
 187         @param  _xField         Font to be converted
 188     */
 189     void callColumnFormatDialog(const css::uno::Reference< css::beans::XPropertySet>& _xAffectedCol,
 190                                 const css::uno::Reference< css::beans::XPropertySet>& _xField,
 191                                 SvNumberFormatter* _pFormatter,
 192                                 vcl::Window* _pParent);
 193
 194     /** second variant of the function before
 195     */
 196     bool callColumnFormatDialog(vcl::Window* _pParent,
 197                                     SvNumberFormatter* _pFormatter,
 198                                     sal_Int32 _nDataType,
 199                                     sal_Int32& _nFormatKey,
 200                                     SvxCellHorJustify& _eJustify,
 201                                     bool  _bHasFormat);
 202     /** append a name to tablefilter of a datasource
 203         @param  _xConnection    the connection is need to get the datasource
 204         @param  _sName          the name which should be appended
 205         @param  _rxContext      needed to check if datasource is available
 206         @param  _pParent        needed when an error must be shown
 207         @return false when datsource is not available otherwise true
 208     */
 209     bool appendToFilter(const css::uno::Reference< css::sdbc::XConnection>& _xConnection,
 210                             const OUString& _sName,
 211                             const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
 212                             vcl::Window* _pParent);
 213
 214     /** notifySystemWindow adds or remove the given window _pToRegister at the Systemwindow found when search _pWindow.
 215         @param  _pWindow
 216             The window which is used to search for the SystemWindow.
 217         @param  _pToRegister
 218             The window which should be added or removed on the TaskPaneList.
 219         @param  _rMemFunc
 220             The member function which should be called at the SystemWindow when found.
 221             Possible values are:
 222             ::comphelper::mem_fun(&TaskPaneList::AddWindow)
 223             ::comphelper::mem_fun(&TaskPaneList::RemoveWindow)
 224     */
 225     void notifySystemWindow(vcl::Window* _pWindow,
 226                             vcl::Window* _pToRegister,
 227                             const ::comphelper::mem_fun1_t<TaskPaneList,vcl::Window*>& _rMemFunc);
 228
 229     /** adjustToolBoxSize checks if the size of the ToolBox is still valid. If not it will be resized.
 230         @param  _pToolBox
 231             The Toolbox which should be resized.
 232     */
 233     void adjustToolBoxSize(ToolBox* _pToolBox);
 234
 235     void adjustBrowseBoxColumnWidth( ::svt::EditBrowseBox* _pBox, sal_uInt16 _nColId );
 236
 237     /** check if SQL92 name checking is enabled
 238         @param  _xConnection
 239             Used to get the datasource as parent from the connection.
 240         @return
 241             <TRUE/> if so otherwise <FALSE/>
 242     */
 243     bool isSQL92CheckEnabled(const css::uno::Reference< css::sdbc::XConnection>& _xConnection);
 244
 245     /** check if the alias name of the table should be added at select statements
 246         @param  _xConnection
 247             Used to get the datasource as parent from the connection.
 248         @return
 249             <TRUE/> if so otherwise <FALSE/>
 250     */
 251     bool isAppendTableAliasEnabled(const css::uno::Reference< css::sdbc::XConnection>& _xConnection);
 252
 253     /** determines whether when generating SQL statements, AS should be placed before a table alias
 254     */
 255     bool generateAsBeforeTableAlias( const css::uno::Reference< css::sdbc::XConnection>& _rxConnection );
 256
 257     /** fills the bool and string value with information out of the datasource info property
 258         @param  _xDatasource
 259             Asked for the properties.
 260         @param  _rAutoIncrementValueEnabled
 261             <OUT/> Set to sal_True when the property was set in the datasource.
 262         @param  _rsAutoIncrementValue
 263             <OUT/> Set to the value when the property was set in the datasource.
 264     */
 265     void fillAutoIncrementValue(const css::uno::Reference< css::beans::XPropertySet>& _xDatasource
 266                                 ,bool& _rAutoIncrementValueEnabled
 267                                 ,OUString& _rsAutoIncrementValue);
 268
 269     /** fills the bool and string value with information out of the datasource info property
 270         @param  _xConnection
 271             Used to get the datasource as parent from the connection.
 272         @param  _rAutoIncrementValueEnabled
 273             <OUT/> Set to sal_True when the property was set in the datasource.
 274         @param  _rsAutoIncrementValue
 275             <OUT/> Set to the value when the property was set in the datasource.
 276     */
 277     void fillAutoIncrementValue(const css::uno::Reference< css::sdbc::XConnection>& _xConnection
 278                                 ,bool& _rAutoIncrementValueEnabled
 279                                 ,OUString& _rsAutoIncrementValue);
 280
 281     /** creates the URL or the help agent
 282         @param  _sModuleName
 283         @param  _nHelpId
 284         @return
 285             The URL for the help agent to dispatch.
 286     */
 287     css::util::URL createHelpAgentURL(const OUString& _sModuleName,const OString& _rHelpId);
 288
 289     /** set the evaluation flag at the number formatter
 290         @param  _rxFormatter
 291     */
 292     void setEvalDateFormatForFormatter(css::uno::Reference< css::util::XNumberFormatter >& _rxFormatter);
 293
 294     /** query for a type info which can be used to create a primary key column
 295         @param  _rTypeInfo
 296             The map which contains all available types.
 297         @return
 298             The type info which can be used to create a primary key column.
 299     */
 300     TOTypeInfoSP queryPrimaryKeyType(const OTypeInfoMap& _rTypeInfo);
 301
 302     /** query for a specific type.
 303         @param  _nDataType
 304             The type we are searching.
 305         @param  _rTypeInfo
 306             The map which contains all available types.
 307         @return
 308             The type or <NULL/> if we can't find it.
 309     */
 310     TOTypeInfoSP queryTypeInfoByType(sal_Int32 _nDataType,const OTypeInfoMap& _rTypeInfo);
 311
 312     /** returns the configuration node name of user defined drivers.
 313         @return
 314             the configuration node name of user defined drivers.
 315     */
 316
 317     /** returns the result of the user action when view the query dialog.
 318         @param  _pParent
 319             The parent of the dialog
 320         @param  _nTitle
 321             A string resource id for the text which will be displayed as title.
 322         @param  _nText
 323             A string resource id for the text which will be displayed above the buttons.
 324             When the string contains a #1. This will be replaced by the name.
 325         @param  _bAll
 326             When set to <TRUE/>, the all button will be appended.
 327         @param  _sName
 328             The name of the object to ask for.
 329         @return
 330             RET_YES, RET_NO, RET_ALL
 331     */
 332     sal_Int32 askForUserAction(vcl::Window* _pParent,sal_uInt16 _nTitle,sal_uInt16 _nText,bool _bAll,const OUString& _sName);
 333
 334     /** creates a new view from a query or table
 335         @param  _sName
 336             The name of the view to be created.
 337         @param  _xConnection
 338             The source connection.
 339         @param  _xSourceObject
 340             The object for which a view should be created.
 341         @return
 342             The created view.
 343     */
 344     css::uno::Reference< css::beans::XPropertySet> createView( const OUString& _sName
 345                                                     ,const css::uno::Reference< css::sdbc::XConnection >& _xConnection
 346                                                     ,const css::uno::Reference< css::beans::XPropertySet>& _xSourceObject);
 347
 348     /** creates a view with the given command
 349     */
 350     css::uno::Reference< css::beans::XPropertySet> createView(
 351         const OUString& _rName,
 352         const css::uno::Reference< css::sdbc::XConnection >& _xConnection,
 353         const OUString& _rCommand
 354     );
 355
 356     /** returns the stripped database name.
 357         @param  _xDataSource
 358             The data source
 359         @param  _rsDatabaseName
 360             Will be filled with the original data source if it is empty.
 361         @return
 362             The stripped database name either the registered name or if it is a file url the last segment.
 363     */
 364     OUString getStrippedDatabaseName(const css::uno::Reference< css::beans::XPropertySet>& _xDataSource
 365                                             ,OUString& _rsDatabaseName);
 366
 367     /** returns the standard database filter
 368         @retrun
 369             the filter
 370     */
 371     std::shared_ptr<const SfxFilter> getStandardDatabaseFilter();
 372
 373     /** opens a save dialog to store a form or report folder in the current hierarchy.
 374         @param  _pParent
 375             The parent of the dialog.
 376         @param _rxContext
 377             a multi service factory which can be used to instantiate usual global services
 378         @param  _xNames
 379             Where to insert the new object.
 380         @param  _sParentFolder
 381             The name of the parent folder.
 382         @param  _bForm
 383             <TRUE/> if a form should be inserted
 384         @param  _bCollection
 385             A folder should be inserted
 386         @param  _xContent
 387             The content which should be copied.
 388         @param  _bMove
 389                 if <TRUE/> the name of the content must be inserted without any change, otherwise not.
 390         @return
 391             <TRUE/> if the insert opertions was successful, otherwise <FALSE/>.
 392     */
 393     bool insertHierachyElement(
 394                 vcl::Window* _pParent,
 395                 const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
 396                 const css::uno::Reference< css::container::XHierarchicalNameContainer>& _xNames,
 397                 const OUString& _sParentFolder,
 398                 bool _bForm,
 399                 bool _bCollection = true,
 400                 const css::uno::Reference< css::ucb::XContent>& _xContent = nullptr,
 401                 bool _bMove = false
 402             );
 403
 404     /** creates a number formatter
 405         @param  _rxConnection
 406             The connection is needed to create the formatter
 407         @param  _rxContext
 408             The multi service factory
 409     */
 410     css::uno::Reference< css::util::XNumberFormatter > getNumberFormatter(const css::uno::Reference< css::sdbc::XConnection >& _rxConnection,const css::uno::Reference< css::uno::XComponentContext >& _rxContext );
 411
 412     // this completes a help url with the system parameters "Language" and "System"
 413     // detect installed locale
 414     void AppendConfigToken( OUString& _rURL, bool _bQuestionMark );
 415
 416 }
 417 #endif // INCLUDED_DBACCESS_SOURCE_UI_INC_UITOOLS_HXX
 418
 419 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */