svx::ODataAccessDescriptor Class Reference

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)
ODataAccessDescriptor &	operator= (const ODataAccessDescriptor &_rSource)
ODataAccessDescriptor &	operator= (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< ODADescriptorImpl >	m_pImpl

Detailed Description

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

Definition at line 64 of file dataaccessdescriptor.hxx.

Constructor & Destructor Documentation

ODataAccessDescriptor() [1/6]

svx::ODataAccessDescriptor::ODataAccessDescriptor

(

)

Definition at line 231 of file dataaccessdescriptor.cxx.

References m_pImpl.

ODataAccessDescriptor() [2/6]

svx::ODataAccessDescriptor::ODataAccessDescriptor

(

const ODataAccessDescriptor &

_rSource

)

Definition at line 236 of file dataaccessdescriptor.cxx.

References m_pImpl.

ODataAccessDescriptor() [3/6]

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

noexcept

Definition at line 241 of file dataaccessdescriptor.cxx.

References m_pImpl.

ODataAccessDescriptor() [4/6]

svx::ODataAccessDescriptor::ODataAccessDescriptor

(

const css::uno::Reference< css::beans::XPropertySet > &

_rValues

)

ODataAccessDescriptor() [5/6]

svx::ODataAccessDescriptor::ODataAccessDescriptor

(

const css::uno::Sequence< css::beans::PropertyValue > &

_rValues

)

ODataAccessDescriptor() [6/6]

svx::ODataAccessDescriptor::ODataAccessDescriptor

(

const css::uno::Any &

_rValues

)

References getDataSource().

~ODataAccessDescriptor()

svx::ODataAccessDescriptor::~ODataAccessDescriptor

(

)

Definition at line 283 of file dataaccessdescriptor.cxx.

Member Function Documentation

clear()

void svx::ODataAccessDescriptor::clear

(

)

empties the descriptor

Definition at line 287 of file dataaccessdescriptor.cxx.

References m_pImpl.

Referenced by svx::OColumnTransferable::implConstruct(), initializeFrom(), and svx::ODataAccessObjectTransferable::ObjectReleased().

createPropertyValueSequence()

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 328 of file dataaccessdescriptor.cxx.

References m_pImpl.

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

erase()

void svx::ODataAccessDescriptor::erase

(

DataAccessDescriptorProperty

_eWhich

)

erases the given property from the descriptor

Definition at line 292 of file dataaccessdescriptor.cxx.

References has(), and m_pImpl.

getDataSource()

OUString svx::ODataAccessDescriptor::getDataSource

(

)

const

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

Definition at line 334 of file dataaccessdescriptor.cxx.

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

Referenced by FmXFormView::implCreateFieldControl().

has()

bool svx::ODataAccessDescriptor::has

(

DataAccessDescriptorProperty

_eWhich

)

const

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

Definition at line 299 of file dataaccessdescriptor.cxx.

References m_pImpl.

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

initializeFrom()

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 322 of file dataaccessdescriptor.cxx.

References clear(), and m_pImpl.

operator=() [1/2]

ODataAccessDescriptor & svx::ODataAccessDescriptor::operator=

(

const ODataAccessDescriptor &

_rSource

)

Definition at line 246 of file dataaccessdescriptor.cxx.

References m_pImpl.

operator=() [2/2]

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

noexcept

Definition at line 253 of file dataaccessdescriptor.cxx.

References m_pImpl.

operator[]() [1/2]

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 316 of file dataaccessdescriptor.cxx.

References Any, and m_pImpl.

operator[]() [2/2]

const Any & svx::ODataAccessDescriptor::operator[]

(

DataAccessDescriptorProperty

_eWhich

)

const

return the value of a given property

Definition at line 304 of file dataaccessdescriptor.cxx.

References Any, has(), and m_pImpl.

setDataSource()

void svx::ODataAccessDescriptor::setDataSource

(

const OUString &

_sDataSourceNameOrLocation

)

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

Parameters

_sDataSourceNameOrLocation

the data source name or database location

Definition at line 344 of file dataaccessdescriptor.cxx.

References aURL, svx::DatabaseLocation, and svx::DataSource.

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

Member Data Documentation

m_pImpl

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

private

Definition at line 66 of file dataaccessdescriptor.hxx.

Referenced by clear(), createPropertyValueSequence(), erase(), has(), initializeFrom(), operator=(), and operator[]().

---

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

• dataaccessdescriptor.hxx
• dataaccessdescriptor.cxx