2001-02-23 07:59:32 -06:00
|
|
|
/*************************************************************************
|
|
|
|
*
|
|
|
|
* $RCSfile: UITools.hxx,v $
|
|
|
|
*
|
2002-11-12 02:43:49 -06:00
|
|
|
* $Revision: 1.18 $
|
2001-02-23 07:59:32 -06:00
|
|
|
*
|
2002-11-12 02:43:49 -06:00
|
|
|
* last change: $Author: oj $ $Date: 2002-11-12 09:43:49 $
|
2001-02-23 07:59:32 -06:00
|
|
|
*
|
|
|
|
* The Contents of this file are made available subject to the terms of
|
|
|
|
* either of the following licenses
|
|
|
|
*
|
|
|
|
* - GNU Lesser General Public License Version 2.1
|
|
|
|
* - Sun Industry Standards Source License Version 1.1
|
|
|
|
*
|
|
|
|
* Sun Microsystems Inc., October, 2000
|
|
|
|
*
|
|
|
|
* GNU Lesser General Public License Version 2.1
|
|
|
|
* =============================================
|
|
|
|
* Copyright 2000 by Sun Microsystems, Inc.
|
|
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
|
|
* MA 02111-1307 USA
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Sun Industry Standards Source License Version 1.1
|
|
|
|
* =================================================
|
|
|
|
* The contents of this file are subject to the Sun Industry Standards
|
|
|
|
* Source License Version 1.1 (the License); You may not use this file
|
|
|
|
* except in compliance with the License. You may obtain a copy of the
|
|
|
|
* License at http://www.openoffice.org/license.html.
|
|
|
|
*
|
|
|
|
* Software provided under this License is provided on an AS IS basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
|
|
|
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
|
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
|
|
|
* See the License for the specific provisions governing your rights and
|
|
|
|
* obligations concerning the Software.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
|
|
|
*
|
|
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
|
|
|
*
|
|
|
|
* All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s): _______________________________________
|
|
|
|
*
|
|
|
|
*
|
|
|
|
************************************************************************/
|
|
|
|
#ifndef DBAUI_TOOLS_HXX
|
|
|
|
#define DBAUI_TOOLS_HXX
|
|
|
|
|
|
|
|
#ifndef _DBHELPER_DBEXCEPTION_HXX_
|
|
|
|
#include <connectivity/dbexception.hxx>
|
|
|
|
#endif
|
2002-04-29 02:07:40 -05:00
|
|
|
#ifndef _COMPHELPER_STLTYPES_HXX_
|
|
|
|
#include <comphelper/stl_types.hxx>
|
2001-02-28 03:11:33 -06:00
|
|
|
#endif
|
2001-07-02 04:31:49 -05:00
|
|
|
#ifndef DBAUI_TYPEINFO_HXX
|
|
|
|
#include "TypeInfo.hxx"
|
|
|
|
#endif
|
2001-09-24 06:19:38 -05:00
|
|
|
#ifndef _SVX_SVXENUM_HXX
|
|
|
|
#include <svx/svxenum.hxx>
|
|
|
|
#endif
|
2002-04-29 02:07:40 -05:00
|
|
|
#ifndef _SV_TASKPANELIST_HXX
|
|
|
|
#include <vcl/taskpanelist.hxx>
|
|
|
|
#endif
|
2002-11-12 02:43:49 -06:00
|
|
|
#ifndef _CONNECTIVITY_DBTOOLS_HXX_
|
|
|
|
#include <connectivity/dbtools.hxx>
|
|
|
|
#endif
|
|
|
|
|
2002-04-29 02:07:40 -05:00
|
|
|
|
2001-07-02 04:31:49 -05:00
|
|
|
// we only need forward decl here
|
|
|
|
namespace com { namespace sun { namespace star {
|
|
|
|
|
|
|
|
namespace beans { class XPropertySet;}
|
|
|
|
namespace container { class XNameAccess;}
|
|
|
|
namespace lang
|
|
|
|
{
|
|
|
|
class XEventListener;
|
|
|
|
class XMultiServiceFactory;
|
|
|
|
}
|
2001-09-20 07:36:09 -05:00
|
|
|
namespace awt
|
|
|
|
{
|
|
|
|
struct FontDescriptor;
|
|
|
|
}
|
2001-07-02 04:31:49 -05:00
|
|
|
namespace sdbc
|
|
|
|
{
|
|
|
|
class XDatabaseMetaData;
|
|
|
|
class XConnection;
|
|
|
|
}
|
2002-08-26 01:50:55 -05:00
|
|
|
namespace util
|
|
|
|
{
|
|
|
|
struct URL;
|
2002-09-26 04:49:09 -05:00
|
|
|
class XNumberFormatter;
|
2002-08-26 01:50:55 -05:00
|
|
|
}
|
2001-07-02 04:31:49 -05:00
|
|
|
|
|
|
|
}}}
|
2001-02-23 07:59:32 -06:00
|
|
|
|
2002-05-24 06:28:12 -05:00
|
|
|
namespace svt
|
|
|
|
{
|
|
|
|
class EditBrowseBox;
|
|
|
|
}
|
|
|
|
|
2001-02-23 07:59:32 -06:00
|
|
|
class Window;
|
2002-04-29 02:07:40 -05:00
|
|
|
class ToolBox;
|
2001-09-20 07:36:09 -05:00
|
|
|
class Font;
|
2001-09-27 00:25:19 -05:00
|
|
|
class SvNumberFormatter;
|
2002-05-24 06:28:12 -05:00
|
|
|
|
2001-02-23 07:59:32 -06:00
|
|
|
// .........................................................................
|
|
|
|
namespace dbaui
|
|
|
|
{
|
|
|
|
// .........................................................................
|
|
|
|
|
2001-02-28 03:11:33 -06:00
|
|
|
/** compose a complete table name from it's up to three parts, regarding to the database meta data composing rules
|
|
|
|
the PropertySet must be support the service com::sun::star::sdbc::table
|
|
|
|
*/
|
2001-02-23 07:59:32 -06:00
|
|
|
void composeTableName( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData >& _rxMetaData,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxTable,
|
|
|
|
::rtl::OUString& _rComposedName,
|
2002-11-12 02:43:49 -06:00
|
|
|
sal_Bool _bQuote,
|
|
|
|
::dbtools::EComposeRule _eRule = ::dbtools::eInDataManipulation);
|
2001-02-23 07:59:32 -06:00
|
|
|
|
2001-02-28 03:11:33 -06:00
|
|
|
/** creates a new connection and appends the eventlistener
|
|
|
|
@param _rsDataSourceName name of the datasource
|
|
|
|
@param _xDatabaseContext the database context
|
|
|
|
@param _rEvtLst the eventlistener which will be added to the new created connection
|
|
|
|
@param _rOUTConnection this parameter will be filled with the new created connection
|
|
|
|
@return SQLExceptionInfo contains a SQLException, SQLContext or a SQLWarning when they araised else .isValid() will return false
|
|
|
|
*/
|
2001-02-23 07:59:32 -06:00
|
|
|
::dbtools::SQLExceptionInfo createConnection(
|
|
|
|
const ::rtl::OUString& _rsDataSourceName,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& _xDatabaseContext,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rMF,
|
|
|
|
::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>& _rEvtLst,
|
|
|
|
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rOUTConnection );
|
|
|
|
|
2001-02-28 03:11:33 -06:00
|
|
|
/** creates a error dialog which displays the SQLExceptionInfo. Also it supports a "more" button where detailed information are available
|
|
|
|
@param _rInfo the error which should be shown, if the info is not valid no error dialog will appear
|
|
|
|
@param _pParent the parent of the error dialog
|
|
|
|
@param _xFactory need to create the dialog
|
|
|
|
*/
|
2001-02-23 07:59:32 -06:00
|
|
|
void showError( const ::dbtools::SQLExceptionInfo& _rInfo,
|
|
|
|
Window* _pParent,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory);
|
2001-02-28 03:11:33 -06:00
|
|
|
|
|
|
|
/** return a vector which contains all key columns for the @see com::sun::star::sdbc::KeyType _nKeyType
|
|
|
|
@param _rxTable the table which must be a @see com::sun::star::sdbcx::XColumnsSupplier
|
|
|
|
@param _nKeyType @see com::sun::star::sdbc::KeyType
|
|
|
|
*/
|
|
|
|
|
|
|
|
::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess> >
|
|
|
|
getKeyColumns( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxTable,
|
|
|
|
sal_Int32 _nKeyType);
|
|
|
|
|
2001-07-02 04:31:49 -05:00
|
|
|
/** fills a map and a vector with localized type names
|
|
|
|
@param _rxConnection the connection to acces the metadata
|
|
|
|
@param _rsTypeNames a list of localized type names seperated with ';'
|
|
|
|
@param _rTypeInfoMap the filled map with the type names
|
|
|
|
@param _rTypeInfoIters the vector filled with map iterators
|
|
|
|
*/
|
|
|
|
void fillTypeInfo( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rxConnection,
|
|
|
|
const String& _rsTypeNames,
|
|
|
|
OTypeInfoMap& _rTypeInfoMap,
|
|
|
|
::std::vector<OTypeInfoMap::iterator>& _rTypeInfoIters);
|
|
|
|
|
|
|
|
/** fill a column with data of a field description
|
|
|
|
@param _rxColumn the column which should be filled
|
|
|
|
@param _pFieldDesc the source of the data
|
|
|
|
*/
|
|
|
|
class OFieldDescription;
|
|
|
|
void setColumnProperties( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxColumn,
|
|
|
|
const OFieldDescription* _pFieldDesc);
|
2001-07-16 01:56:28 -05:00
|
|
|
|
|
|
|
::rtl::OUString createDefaultName( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData>& _xMetaData,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess>& _xTables,
|
|
|
|
const ::rtl::OUString& _sName);
|
2001-07-18 02:51:19 -05:00
|
|
|
|
|
|
|
/** checks if the given name exists in the database context
|
|
|
|
*/
|
|
|
|
sal_Bool checkDataSourceAvailable( const ::rtl::OUString& _sDataSourceName,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory_xORB);
|
2001-09-20 06:59:25 -05:00
|
|
|
|
|
|
|
/** maps SvxCellHorJustify to com::sun::star::awt::TextAlign
|
|
|
|
@param SvxCellHorJustify& _eAlignment
|
|
|
|
@return the corresponding com::sun::star::awt::TextAlign
|
|
|
|
*/
|
|
|
|
sal_Int32 mapTextAllign(const SvxCellHorJustify& _eAlignment);
|
2002-09-24 03:48:22 -05:00
|
|
|
|
|
|
|
/** maps com::sun::star::awt::TextAlign to SvxCellHorJustify
|
|
|
|
@param com::sun::star::awt::TextAlign& _nAlignment
|
|
|
|
@return the corresponding SvxCellHorJustify
|
|
|
|
*/
|
|
|
|
SvxCellHorJustify mapTextJustify(const sal_Int32& _nAlignment);
|
|
|
|
|
2001-09-20 06:59:25 -05:00
|
|
|
/** fill a column with ui data of a field description
|
|
|
|
@param _rxColumn the column which should be filled
|
|
|
|
@param _pFieldDesc the source of the data
|
|
|
|
*/
|
|
|
|
void setColumnUiProperties( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxColumn,
|
|
|
|
const OFieldDescription* _pFieldDesc);
|
2001-09-20 07:36:09 -05:00
|
|
|
|
|
|
|
/** convert Font to ::com::sun::star::awt::FontDescriptor
|
|
|
|
@param _rFont Font to be converted
|
|
|
|
@return the new FontDescriptor
|
|
|
|
*/
|
|
|
|
::com::sun::star::awt::FontDescriptor CreateFontDescriptor( const Font& _rFont );
|
2001-09-27 00:25:19 -05:00
|
|
|
|
|
|
|
/** call teh format dialog and set the selected format at the column
|
|
|
|
@param _xAffectedCol Font to be converted
|
|
|
|
@param _xField Font to be converted
|
|
|
|
*/
|
|
|
|
void callColumnFormatDialog(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xAffectedCol,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xField,
|
|
|
|
SvNumberFormatter* _pFormatter,
|
|
|
|
Window* _pParent);
|
|
|
|
|
|
|
|
/** second variant of the function before
|
|
|
|
*/
|
|
|
|
sal_Bool callColumnFormatDialog(Window* _pParent,
|
|
|
|
SvNumberFormatter* _pFormatter,
|
|
|
|
sal_Int32 _nDataType,
|
|
|
|
sal_Int32& _nFormatKey,
|
|
|
|
SvxCellHorJustify& _eJustify,
|
|
|
|
sal_uInt16& _nFlags,
|
|
|
|
sal_Bool _bHasFormat);
|
2001-11-12 03:34:55 -06:00
|
|
|
/** append a name to tablefilter of a datasource
|
|
|
|
@param _xConnection the connection is need to get the datasource
|
|
|
|
@param _sName the name which should be appended
|
|
|
|
@param _xFactory needed to check if datasource is available
|
|
|
|
@param _pParent needed when an error must be shown
|
|
|
|
@return false when datsource is not available otherwise true
|
|
|
|
*/
|
|
|
|
sal_Bool appendToFilter(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection,
|
|
|
|
const ::rtl::OUString& _sName,
|
|
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory,
|
|
|
|
Window* _pParent);
|
2001-09-27 00:25:19 -05:00
|
|
|
|
2002-04-29 02:07:40 -05:00
|
|
|
/** notifySystemWindow adds or remove the given window _pToRegister at the Systemwindow found when search _pWindow.
|
|
|
|
@param _pWindow
|
|
|
|
The window which is used to search for the SystemWindow.
|
|
|
|
@param _pToRegister
|
|
|
|
The window which should be added or removed on the TaskPaneList.
|
|
|
|
@param _rMemFunc
|
|
|
|
The member function which should be called at the SystemWindow when found.
|
|
|
|
Possible values are:
|
|
|
|
::comphelper::mem_fun(&TaskPaneList::AddWindow)
|
|
|
|
::comphelper::mem_fun(&TaskPaneList::RemoveWindow)
|
|
|
|
*/
|
|
|
|
void notifySystemWindow(Window* _pWindow,
|
|
|
|
Window* _pToRegister,
|
|
|
|
::comphelper::mem_fun1_t<TaskPaneList,Window*> _rMemFunc);
|
|
|
|
|
|
|
|
/** adjustToolBoxSize checks if the size of the ToolBox is still valid. If not it will be resized.
|
|
|
|
@param _pToolBox
|
|
|
|
The Toolbox which should be resized.
|
|
|
|
*/
|
|
|
|
void adjustToolBoxSize(ToolBox* _pToolBox);
|
|
|
|
|
|
|
|
/** isHiContrast check if we are in hi contrast mode.
|
|
|
|
@param _pWindow
|
|
|
|
The window we have to check on.
|
|
|
|
@return
|
|
|
|
<TRUE/> if so, otherwise <FALSE/>
|
|
|
|
*/
|
|
|
|
sal_Bool isHiContrast(Window* _pWindow);
|
|
|
|
|
2002-05-24 06:28:12 -05:00
|
|
|
void adjustBrowseBoxColumnWidth( ::svt::EditBrowseBox* _pBox, sal_uInt16 _nColId );
|
|
|
|
|
2002-07-09 06:48:40 -05:00
|
|
|
/** check if SQL92 name checking is enabled
|
|
|
|
@param _xConnection
|
2002-07-25 00:55:23 -05:00
|
|
|
Used to get the datasource as parent from the connection.
|
2002-07-09 06:48:40 -05:00
|
|
|
@return
|
|
|
|
<TRUE/> if so otherwise <FALSE/>
|
|
|
|
*/
|
|
|
|
sal_Bool isSQL92CheckEnabled(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection);
|
|
|
|
|
2002-07-25 00:55:23 -05:00
|
|
|
/** fills the bool and string value with information out of the datasource info property
|
|
|
|
@param _xDatasource
|
|
|
|
Asked for the properties.
|
|
|
|
@param _rAutoIncrementValueEnabled
|
|
|
|
<OUT/> Set to TRUE when the property was set in the datasource.
|
|
|
|
@param _rsAutoIncrementValue
|
|
|
|
<OUT/> Set to the value when the property was set in the datasource.
|
|
|
|
*/
|
|
|
|
void fillAutoIncrementValue(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xDatasource
|
|
|
|
,sal_Bool& _rAutoIncrementValueEnabled
|
|
|
|
,::rtl::OUString& _rsAutoIncrementValue);
|
|
|
|
|
|
|
|
/** fills the bool and string value with information out of the datasource info property
|
|
|
|
@param _xConnection
|
|
|
|
Used to get the datasource as parent from the connection.
|
|
|
|
@param _rAutoIncrementValueEnabled
|
|
|
|
<OUT/> Set to TRUE when the property was set in the datasource.
|
|
|
|
@param _rsAutoIncrementValue
|
|
|
|
<OUT/> Set to the value when the property was set in the datasource.
|
|
|
|
*/
|
|
|
|
void fillAutoIncrementValue(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection
|
|
|
|
,sal_Bool& _rAutoIncrementValueEnabled
|
|
|
|
,::rtl::OUString& _rsAutoIncrementValue);
|
|
|
|
|
2002-08-26 01:50:55 -05:00
|
|
|
/** creates the URL or the help agent
|
|
|
|
@param _sModuleName
|
|
|
|
@param _nHelpId
|
|
|
|
@return
|
|
|
|
The URL for the help agent to dispatch.
|
|
|
|
*/
|
|
|
|
::com::sun::star::util::URL createHelpAgentURL(const ::rtl::OUString& _sModuleName,const sal_Int32 _nHelpId);
|
|
|
|
|
2002-09-26 04:49:09 -05:00
|
|
|
/** set the evaluation flag at the number formatter
|
|
|
|
@param _rxFormatter
|
|
|
|
*/
|
|
|
|
void setEvalDateFormatForFormatter(::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter);
|
|
|
|
|
2001-02-23 07:59:32 -06:00
|
|
|
// .........................................................................
|
|
|
|
}
|
|
|
|
// .........................................................................
|
|
|
|
#endif // DBAUI_TOOLS_HXX
|
|
|
|
|
|
|
|
|