LibreOffice Module svx (master)  1
Public Member Functions | Private Attributes | List of all members
svx::ODataAccessDescriptor Class Referencefinal

class encapsulating the css::sdb::DataAccessDescriptor service. More...

#include <dataaccessdescriptor.hxx>

Public Member Functions

 ODataAccessDescriptor ()
 
 ODataAccessDescriptor (const ODataAccessDescriptor &_rSource)
 
 ODataAccessDescriptor (ODataAccessDescriptor &&_rSource) noexcept
 
 ODataAccessDescriptor (const css::uno::Reference< css::beans::XPropertySet > &_rValues)
 
 ODataAccessDescriptor (const css::uno::Sequence< css::beans::PropertyValue > &_rValues)
 
 ODataAccessDescriptor (const css::uno::Any &_rValues)
 
ODataAccessDescriptoroperator= (const ODataAccessDescriptor &_rSource)
 
ODataAccessDescriptoroperator= (ODataAccessDescriptor &&_rSource) noexcept
 
 ~ODataAccessDescriptor ()
 
css::uno::Sequence< css::beans::PropertyValue > const & createPropertyValueSequence ()
 returns the descriptor as property value sequence More...
 
void initializeFrom (const css::uno::Sequence< css::beans::PropertyValue > &_rValues)
 initialized the descriptor from the property values given The descriptor will clear all its current settings before initializing with the new ones. More...
 
bool has (DataAccessDescriptorProperty _eWhich) const
 checks whether or not a given property is present in the descriptor More...
 
void erase (DataAccessDescriptorProperty _eWhich)
 erases the given property from the descriptor More...
 
void clear ()
 empties the descriptor More...
 
const css::uno::Any & operator[] (DataAccessDescriptorProperty _eWhich) const
 return the value of a given property More...
 
css::uno::Any & operator[] (DataAccessDescriptorProperty _eWhich)
 return the (modifiable) value of a given property More...
 
OUString getDataSource () const
 returns either the data source name if given or the database location More...
 
void setDataSource (const OUString &_sDataSourceNameOrLocation)
 set the data source name, if it is not file URL More...
 

Private Attributes

std::unique_ptr< ODADescriptorImplm_pImpl
 

Detailed Description

class encapsulating the css::sdb::DataAccessDescriptor service.

Definition at line 64 of file dataaccessdescriptor.hxx.

Constructor & Destructor Documentation

svx::ODataAccessDescriptor::ODataAccessDescriptor ( )

Definition at line 234 of file dataaccessdescriptor.cxx.

svx::ODataAccessDescriptor::ODataAccessDescriptor ( const ODataAccessDescriptor _rSource)

Definition at line 239 of file dataaccessdescriptor.cxx.

svx::ODataAccessDescriptor::ODataAccessDescriptor ( ODataAccessDescriptor &&  _rSource)
noexcept

Definition at line 244 of file dataaccessdescriptor.cxx.

svx::ODataAccessDescriptor::ODataAccessDescriptor ( const css::uno::Reference< css::beans::XPropertySet > &  _rValues)
svx::ODataAccessDescriptor::ODataAccessDescriptor ( const css::uno::Sequence< css::beans::PropertyValue > &  _rValues)
svx::ODataAccessDescriptor::ODataAccessDescriptor ( const css::uno::Any &  _rValues)
svx::ODataAccessDescriptor::~ODataAccessDescriptor ( )

Definition at line 286 of file dataaccessdescriptor.cxx.

Member Function Documentation

void svx::ODataAccessDescriptor::clear ( )
Sequence< PropertyValue > const & svx::ODataAccessDescriptor::createPropertyValueSequence ( )

returns the descriptor as property value sequence

If you call this method more than once, without writing any values between both calls, the same object is returned. If you wrote values, a new object is returned.

Definition at line 331 of file dataaccessdescriptor.cxx.

References m_pImpl.

Referenced by svx::OComponentTransferable::GetData(), svx::OColumnTransferable::GetData(), and svx::ODataAccessObjectTransferable::GetData().

void svx::ODataAccessDescriptor::erase ( DataAccessDescriptorProperty  _eWhich)

erases the given property from the descriptor

Definition at line 295 of file dataaccessdescriptor.cxx.

References has(), and m_pImpl.

OUString svx::ODataAccessDescriptor::getDataSource ( ) const

returns either the data source name if given or the database location

Definition at line 337 of file dataaccessdescriptor.cxx.

References svx::DatabaseLocation, svx::DataSource, and has().

Referenced by FmXFormView::implCreateFieldControl().

bool svx::ODataAccessDescriptor::has ( DataAccessDescriptorProperty  _eWhich) const

checks whether or not a given property is present in the descriptor

Definition at line 302 of file dataaccessdescriptor.cxx.

References m_pImpl.

Referenced by erase(), svx::OColumnTransferable::extractColumnDescriptor(), getDataSource(), svx::OColumnTransferable::OColumnTransferable(), and operator[]().

void svx::ODataAccessDescriptor::initializeFrom ( const css::uno::Sequence< css::beans::PropertyValue > &  _rValues)

initialized the descriptor from the property values given The descriptor will clear all its current settings before initializing with the new ones.

Definition at line 325 of file dataaccessdescriptor.cxx.

References clear(), and m_pImpl.

ODataAccessDescriptor & svx::ODataAccessDescriptor::operator= ( const ODataAccessDescriptor _rSource)

Definition at line 249 of file dataaccessdescriptor.cxx.

References m_pImpl.

ODataAccessDescriptor & svx::ODataAccessDescriptor::operator= ( ODataAccessDescriptor &&  _rSource)
noexcept

Definition at line 256 of file dataaccessdescriptor.cxx.

References m_pImpl.

const Any & svx::ODataAccessDescriptor::operator[] ( DataAccessDescriptorProperty  _eWhich) const

return the value of a given property

Definition at line 307 of file dataaccessdescriptor.cxx.

References Any, has(), and m_pImpl.

Any & svx::ODataAccessDescriptor::operator[] ( DataAccessDescriptorProperty  _eWhich)

return the (modifiable) value of a given property

This operator is not allowed to be called if the descriptor is readonly.

Definition at line 319 of file dataaccessdescriptor.cxx.

References Any, and m_pImpl.

void svx::ODataAccessDescriptor::setDataSource ( const OUString &  _sDataSourceNameOrLocation)

set the data source name, if it is not file URL

Parameters
_sDataSourceNameOrLocationthe data source name or database location

Definition at line 347 of file dataaccessdescriptor.cxx.

References svx::DatabaseLocation, svx::DataSource, and INetURLObject::GetProtocol().

Referenced by svx::ODataAccessObjectTransferable::construct(), svx::OColumnTransferable::implConstruct(), and svx::OComponentTransferable::OComponentTransferable().

Member Data Documentation

std::unique_ptr<ODADescriptorImpl> svx::ODataAccessDescriptor::m_pImpl
private

The documentation for this class was generated from the following files: