diff options
Diffstat (limited to 'dbaccess/source/ui/inc/UITools.hxx')
| -rw-r--r-- | dbaccess/source/ui/inc/UITools.hxx | 160 |
1 files changed, 80 insertions, 80 deletions
diff --git a/dbaccess/source/ui/inc/UITools.hxx b/dbaccess/source/ui/inc/UITools.hxx index 8bd112c38742..6ecab0555549 100644 --- a/dbaccess/source/ui/inc/UITools.hxx +++ b/dbaccess/source/ui/inc/UITools.hxx @@ -2,7 +2,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -35,12 +35,12 @@ #include <vcl/taskpanelist.hxx> #include <connectivity/dbtools.hxx> -#define RET_ALL 10 +#define RET_ALL 10 // we only need forward decl here namespace com { namespace sun { namespace star { - namespace beans { class XPropertySet;} + namespace beans { class XPropertySet;} namespace container { class XNameAccess; @@ -95,12 +95,12 @@ namespace dbaui class DBTreeListBox; /** creates a new connection and appends the eventlistener - @param _rsDataSourceName name of the datasource - @param _xDatabaseContext the database context + @param _rsDataSourceName name of the datasource + @param _xDatabaseContext the database context @param _rMF the multi service factory - @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 + @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 */ ::dbtools::SQLExceptionInfo createConnection( const ::rtl::OUString& _rsDataSourceName, @@ -109,11 +109,11 @@ namespace dbaui ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>& _rEvtLst, ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rOUTConnection ); /** creates a new connection and appends the eventlistener - @param _xDataSource the datasource + @param _xDataSource the datasource @param _rMF the multi service factory - @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 + @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 */ ::dbtools::SQLExceptionInfo createConnection( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _xDataSource, @@ -121,50 +121,50 @@ namespace dbaui ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>& _rEvtLst, ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rOUTConnection ); - /** 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 + /** 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 */ - void showError( const ::dbtools::SQLExceptionInfo& _rInfo, + void showError( const ::dbtools::SQLExceptionInfo& _rInfo, Window* _pParent, const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory); /** 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 + @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::container::XIndexAccess >& _rxKeys, + getKeyColumns( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& _rxKeys, sal_Int32 _nKeyType); /** 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 + @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, + 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 + @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, + void setColumnProperties( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxColumn, const OFieldDescription* _pFieldDesc); - ::rtl::OUString createDefaultName( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData>& _xMetaData, + ::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); /** checks if the given name exists in the database context */ - sal_Bool checkDataSourceAvailable( const ::rtl::OUString& _sDataSourceName, + sal_Bool checkDataSourceAvailable( const ::rtl::OUString& _sDataSourceName, const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory_xORB); /** maps SvxCellHorJustify to com::sun::star::awt::TextAlign @@ -197,7 +197,7 @@ namespace dbaui ::dbtools::SQLExceptionInfo* _pErrorInfo ); - /** returns either the model when data source is given as parameter, + /** returns either the model when data source is given as parameter, or returns a data source when a model is given. @param _xObject Either a data source or a model. */ @@ -210,14 +210,14 @@ namespace dbaui SvxCellHorJustify mapTextJustify(const sal_Int32& _nAlignment); /** convert Font to ::com::sun::star::awt::FontDescriptor - @param _rFont Font to be converted - @return the new FontDescriptor + @param _rFont Font to be converted + @return the new FontDescriptor */ ::com::sun::star::awt::FontDescriptor CreateFontDescriptor( const Font& _rFont ); /** call teh format dialog and set the selected format at the column - @param _xAffectedCol Font to be converted - @param _xField Font to be converted + @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, @@ -231,13 +231,13 @@ namespace dbaui sal_Int32 _nDataType, sal_Int32& _nFormatKey, SvxCellHorJustify& _eJustify, - sal_uInt16& _nFlags, + sal_uInt16& _nFlags, sal_Bool _bHasFormat); /** 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 + @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, @@ -246,11 +246,11 @@ namespace dbaui Window* _pParent); /** notifySystemWindow adds or remove the given window _pToRegister at the Systemwindow found when search _pWindow. - @param _pWindow + @param _pWindow The window which is used to search for the SystemWindow. - @param _pToRegister + @param _pToRegister The window which should be added or removed on the TaskPaneList. - @param _rMemFunc + @param _rMemFunc The member function which should be called at the SystemWindow when found. Possible values are: ::comphelper::mem_fun(&TaskPaneList::AddWindow) @@ -261,13 +261,13 @@ namespace dbaui ::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 + @param _pToolBox The Toolbox which should be resized. */ void adjustToolBoxSize(ToolBox* _pToolBox); /** isHiContrast check if we are in hi contrast mode. - @param _pWindow + @param _pWindow The window we have to check on. @return <TRUE/> if so, otherwise <FALSE/> @@ -277,7 +277,7 @@ namespace dbaui void adjustBrowseBoxColumnWidth( ::svt::EditBrowseBox* _pBox, sal_uInt16 _nColId ); /** check if SQL92 name checking is enabled - @param _xConnection + @param _xConnection Used to get the datasource as parent from the connection. @return <TRUE/> if so otherwise <FALSE/> @@ -285,7 +285,7 @@ namespace dbaui sal_Bool isSQL92CheckEnabled(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection); /** check if the alias name of the table should be added at select statements - @param _xConnection + @param _xConnection Used to get the datasource as parent from the connection. @return <TRUE/> if so otherwise <FALSE/> @@ -297,11 +297,11 @@ namespace dbaui sal_Bool generateAsBeforeTableAlias( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rxConnection ); /** fills the bool and string value with information out of the datasource info property - @param _xDatasource + @param _xDatasource Asked for the properties. - @param _rAutoIncrementValueEnabled + @param _rAutoIncrementValueEnabled <OUT/> Set to TRUE when the property was set in the datasource. - @param _rsAutoIncrementValue + @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 @@ -309,11 +309,11 @@ namespace dbaui ,::rtl::OUString& _rsAutoIncrementValue); /** fills the bool and string value with information out of the datasource info property - @param _xConnection + @param _xConnection Used to get the datasource as parent from the connection. - @param _rAutoIncrementValueEnabled + @param _rAutoIncrementValueEnabled <OUT/> Set to TRUE when the property was set in the datasource. - @param _rsAutoIncrementValue + @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 @@ -321,20 +321,20 @@ namespace dbaui ,::rtl::OUString& _rsAutoIncrementValue); /** creates the URL or the help agent - @param _sModuleName - @param _nHelpId + @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); + ::com::sun::star::util::URL createHelpAgentURL(const ::rtl::OUString& _sModuleName,const sal_Int32 _nHelpId); /** set the evaluation flag at the number formatter - @param _rxFormatter + @param _rxFormatter */ void setEvalDateFormatForFormatter(::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter); /** query for a type info which can be used to create a primary key column - @param _rTypeInfo + @param _rTypeInfo The map which contains all available types. @return The type info which can be used to create a primary key column. @@ -342,9 +342,9 @@ namespace dbaui TOTypeInfoSP queryPrimaryKeyType(const OTypeInfoMap& _rTypeInfo); /** query for a specific type. - @param _nDataType + @param _nDataType The type we are searching. - @param _rTypeInfo + @param _rTypeInfo The map which contains all available types. @return The type or <NULL/> if we can't find it. @@ -355,18 +355,18 @@ namespace dbaui @return the configuration node name of user defined drivers. */ - + /** returns the result of the user action when view the query dialog. - @param _pParent + @param _pParent The parent of the dialog - @param _nTitle + @param _nTitle A string resource id for the text which will be displayed as title. - @param _nText + @param _nText A string resource id for the text which will be displayed above the buttons. When the string contains a #1. This will be replaced by the name. - @param _bAll + @param _bAll When set to <TRUE/>, the all button will be appended. - @param _sName + @param _sName The name of the object to ask for. @return RET_YES, RET_NO, RET_ALL @@ -374,11 +374,11 @@ namespace dbaui sal_Int32 askForUserAction(Window* _pParent,USHORT _nTitle,USHORT _nText,sal_Bool _bAll,const ::rtl::OUString& _sName); /** creates a new view from a query or table - @param _sName + @param _sName The name of the view to be created. - @param _xConnection + @param _xConnection The source connection. - @param _xSourceObject + @param _xSourceObject The object for which a view should be created. @return The created view. @@ -396,9 +396,9 @@ namespace dbaui ); /** returns the stripped database name. - @param _xDataSource + @param _xDataSource The data source - @param _rsDatabaseName + @param _rsDatabaseName Will be filled with the original data source if it is empty. @return The stripped database name either the registered naem or if it is a file url the last segment. @@ -413,21 +413,21 @@ namespace dbaui const SfxFilter* getStandardDatabaseFilter(); /** opens a save dialog to store a form or report folder in the current hierachy. - @param _pParent + @param _pParent The parent of the dialog. @param _rxORB a multi service factory which can be used to instantiate usual global services - @param _xNames + @param _xNames Where to insert the new object. - @param _sParentFolder + @param _sParentFolder The name of the parent folder. - @param _bForm + @param _bForm <TRUE/> if a form should be inserted - @param _bCollection + @param _bCollection A folder should be inserted - @param _xContent + @param _xContent The content which should be copied. - @param _bMove + @param _bMove if <TRUE/> the name of the content must be inserted without any change, otherwise not. @return <TRUE/> if the insert opertions was successfull, otherwise <FALSE/>. @@ -444,9 +444,9 @@ namespace dbaui ); /** creates a number formatter - @param _rxConnection + @param _rxConnection The connection is needed to create the formatter - @param _rMF + @param _rMF The multi service factory */ ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter > getNumberFormatter(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rMF ); |