/usr/include/libreoffice/cppuhelper/propertysetmixin.hxx is in libreoffice-dev 1:3.5.7-0ubuntu13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX
#define INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX \
INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX
#include "sal/config.h"
#include "com/sun/star/beans/PropertyVetoException.hpp"
#include "com/sun/star/beans/UnknownPropertyException.hpp"
#include "com/sun/star/beans/XFastPropertySet.hpp"
#include "com/sun/star/beans/XPropertyAccess.hpp"
#include "com/sun/star/beans/XPropertySet.hpp"
#include "com/sun/star/lang/IllegalArgumentException.hpp"
#include "com/sun/star/lang/WrappedTargetException.hpp"
#include "com/sun/star/uno/Reference.hxx"
#include "com/sun/star/uno/RuntimeException.hpp"
#include "com/sun/star/uno/Sequence.hxx"
#include "sal/types.h"
/// @HTML
namespace com { namespace sun { namespace star {
namespace beans {
class XPropertyChangeListener;
class XPropertySetInfo;
class XVetoableChangeListener;
struct PropertyValue;
}
namespace uno {
class Any;
class Type;
class XComponentContext;
}
} } }
namespace rtl { class OUString; }
namespace cppu {
template< typename T > class PropertySetMixin;
// Suppress warnings about virtual functions but non-virtual destructor:
#if defined _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4265)
#endif
/**
@short A helper base class for <code>cppu::PropertySetMixin</code>.
@descr See the documentation of <code>cppu::PropertySetMixin</code> for
further details.
@descr That <code>cppu::PropertySetMixin</code> is derived from this
base class should be considered an implementation detail. The functionality
of <code>cppu::PropertySetMixin</code> that is inherited from this base
class and is visible to subclasses of
<code>cppu::PropertySetMixin</code> should be treated by such
subclasses as being provided by <code>cppu::PropertySetMixin</code>
directly (e.g., in such subclasses, use
“<code>PropertySetMixin::Implements</code>” instead of
“<code>PropertySetMixinImpl::Implements</code>”).
@since UDK 3.2.1
*/
class PropertySetMixinImpl:
public com::sun::star::beans::XPropertySet,
public com::sun::star::beans::XFastPropertySet,
public com::sun::star::beans::XPropertyAccess
{
protected:
/**
@short Flags used by subclasses of
<code>cppu::PropertySetMixin</code> to specify what UNO interface
types shall be supported.
*/
enum Implements {
/**
@short Flag specifying that the UNO interface type
<code>com::sun::star::beans::XPropertySet</code> shall be supported.
*/
IMPLEMENTS_PROPERTY_SET = 1,
/**
@short Flag specifying that the UNO interface type
<code>com::sun::star::beans::XFastPropertySet</code> shall be
supported.
*/
IMPLEMENTS_FAST_PROPERTY_SET = 2,
/**
@short Flag specifying that the UNO interface type
<code>com::sun::star::beans::XPropertyAccess</code> shall be
supported.
*/
IMPLEMENTS_PROPERTY_ACCESS = 4
};
/**
@short A class used by subclasses of
<code>cppu::PropertySetMixin</code> when implementing UNO interface
type attribute setter functions.
@descr This class is not thread safe; that is, the constructor,
<code>notify</code>, and the destructor must be called from the same
thread.
@descr See <code>cppu::PropertySetMixinImpl::prepareSet</code> for
further details.
*/
class BoundListeners {
public:
/**
@short The constructor.
@descr May throw <code>std::bad_alloc</code>.
*/
BoundListeners();
/**
@short The destructor.
@descr Does not throw.
*/
~BoundListeners();
/**
@short Notifies any
<code>com::sun::star::beans::XPropertyChangeListener</code>s.
@descr May throw <code>com::sun::star::uno::RuntimeException</code>
and <code>std::bad_alloc</code>.
@descr See <code>cppu::PropertySetMixinImpl::prepareSet</code>
for further details.
*/
void notify() const;
private:
BoundListeners(BoundListeners &); // not defined
void operator =(BoundListeners); // not defined
class Impl;
Impl * m_impl;
friend class PropertySetMixinImpl;
};
/**
@short A function used by subclasses of
<code>cppu::PropertySetMixin</code> when implementing UNO interface
type attribute setter functions.
@descr First, this function checks whether this instance has already been
disposed (see <code>cppu::PropertySetMixinImpl::dispose</code>),
and throws a <code>com::sun::star::lang::DisposedException</code> if
applicable. For a constrained attribute (whose setter can explicitly
raise <code>com::sun::star::beans::PropertyVetoException</code>), this
function notifies any
<code>com::sun::star::beans::XVetoableChangeListener</code>s. For a
bound attribute, this function modifies the passed-in
<code>boundListeners</code> so that it can afterwards be used to notify
any <code>com::sun::star::beans::XPropertyChangeListener</code>s. This
function should be called before storing the new attribute value, and
<code>boundListeners->notify()</code> should be called exactly once after
storing the new attribute value (in case the attribute is bound;
otherwise, calling <code>boundListeners->notify()</code> is ignored).
Furthermore, <code>boundListeners->notify()</code> and this function have
to be called from the same thread.
@descr May throw
<code>com::sun::star::beans::PropertyVetoException</code>,
<code>com::sun::star::uno::RuntimeException</code> (and
<code>com::sun::star::lang::DisposedException</code> in particular), and
<code>std::bad_alloc</code>.
@param propertyName the name of the property (which is the same as the
name of the attribute that is going to be set)
@param oldValue the property value corresponding to the old attribute
value. This is only used as
<code>com::sun::star::beans::PropertyChangeEvent::OldValue</code>, which
is rather useless, anyway (see “Using the Observer Pattern”
in <a href="http://tools.openoffice.org/CodingGuidelines.sxw">
<cite>OpenOffice.org Coding Guidelines</cite></a>). If the attribute
that is going to be set is neither bound nor constrained, or if
<code>com::sun::star::beans::PropertyChangeEvent::OldValue</code> should
not be set, a <code>VOID</code> <code>Any</code> can be used instead.
@param newValue the property value corresponding to the new
attribute value. This is only used as
<code>com::sun::star::beans::PropertyChangeEvent::NewValue</code>, which
is rather useless, anyway (see “Using the Observer Pattern”
in <a href="http://tools.openoffice.org/CodingGuidelines.sxw">
<cite>OpenOffice.org Coding Guidelines</cite></a>), <em>unless</em> the
attribute that is going to be set is constrained. If the attribute
that is going to be set is neither bound nor constrained, or if it is
only bound but
<code>com::sun::star::beans::PropertyChangeEvent::NewValue</code> should
not be set, a <code>VOID</code> <code>Any</code> can be used instead.
@param boundListeners a pointer to a fresh
<code>cppu::PropertySetMixinImpl::BoundListeners</code> instance
(which has not been passed to this function before, and on which
<code>notify</code> has not yet been called); may only be null if the
attribute that is going to be set is not bound
*/
void prepareSet(
rtl::OUString const & propertyName,
com::sun::star::uno::Any const & oldValue,
com::sun::star::uno::Any const & newValue,
BoundListeners * boundListeners);
/**
@short Mark this instance as being disposed.
@descr See <code>com::sun::star::lang::XComponent</code> for the general
concept of disposing UNO objects. On the first call to this function,
all registered listeners
(<code>com::sun::star::beans::XPropertyChangeListener</code>s and
<code>com::sun::star::beans::XVetoableChangeListener</code>s) are
notified of the disposing source. Any subsequent calls to this function
are ignored.
@descr May throw <code>com::sun::star::uno::RuntimeException</code> and
<code>std::bad_alloc</code>.
*/
void dispose();
/**
@short A function used by subclasses of
<code>cppu::PropertySetMixin</code> when implementing
<code>com::sun::star::uno::XInterface::queryInterface</code>.
@descr This function checks for support of any of the UNO interface types
specified in the call of the <code>cppu::PropertySetMixin</code>
constructor. It does not check for any other UNO interface types (not
even for <code>com::sun::star::uno::XInterface</code>), and should not
be used directly as the implementation of
<code>com::sun::star::uno::XInterface::queryInterface</code> of this UNO
object.
*/
virtual com::sun::star::uno::Any SAL_CALL queryInterface(
com::sun::star::uno::Type const & type)
throw (com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XPropertySet::getPropertySetInfo
virtual
com::sun::star::uno::Reference< com::sun::star::beans::XPropertySetInfo >
SAL_CALL getPropertySetInfo() throw (com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XPropertySet::setPropertyValue
virtual void SAL_CALL setPropertyValue(
rtl::OUString const & propertyName,
com::sun::star::uno::Any const & value)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::beans::PropertyVetoException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XPropertySet::getPropertyValue
virtual com::sun::star::uno::Any SAL_CALL getPropertyValue(
rtl::OUString const & propertyName)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
/**
@short Adds a
<code>com::sun::star::beans::XPropertyChangeListener</code>.
@descr If a listener is added more than once, it will receive all
relevant notifications multiple times.
@see com::sun::star::beans::XPropertySet::addPropertyChangeListener
*/
virtual void SAL_CALL addPropertyChangeListener(
rtl::OUString const & propertyName,
com::sun::star::uno::Reference<
com::sun::star::beans::XPropertyChangeListener > const & listener)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XPropertySet::removePropertyChangeListener
virtual void SAL_CALL removePropertyChangeListener(
rtl::OUString const & propertyName,
com::sun::star::uno::Reference<
com::sun::star::beans::XPropertyChangeListener > const & listener)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
/**
@short Adds a
<code>com::sun::star::beans::XVetoableChangeListener</code>.
@descr If a listener is added more than once, it will receive all
relevant notifications multiple times.
@see com::sun::star::beans::XPropertySet::addVetoableChangeListener
*/
virtual void SAL_CALL addVetoableChangeListener(
rtl::OUString const & propertyName,
com::sun::star::uno::Reference<
com::sun::star::beans::XVetoableChangeListener > const & listener)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XPropertySet::removeVetoableChangeListener
virtual void SAL_CALL removeVetoableChangeListener(
rtl::OUString const & propertyName,
com::sun::star::uno::Reference<
com::sun::star::beans::XVetoableChangeListener > const & listener)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XFastPropertySet::setFastPropertyValue
virtual void SAL_CALL setFastPropertyValue(
sal_Int32 handle, com::sun::star::uno::Any const & value)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::beans::PropertyVetoException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XFastPropertySet::getFastPropertyValue
virtual com::sun::star::uno::Any SAL_CALL getFastPropertyValue(
sal_Int32 handle)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XPropertyAccess::getPropertyValues
virtual
com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >
SAL_CALL getPropertyValues() throw (com::sun::star::uno::RuntimeException);
// @see com::sun::star::beans::XPropertyAccess::setPropertyValues
virtual void SAL_CALL setPropertyValues(
com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >
const & props)
throw (
com::sun::star::beans::UnknownPropertyException,
com::sun::star::beans::PropertyVetoException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException,
com::sun::star::uno::RuntimeException);
private:
PropertySetMixinImpl(PropertySetMixinImpl &); // not defined
void operator =(PropertySetMixinImpl &); // not defined
PropertySetMixinImpl(
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >
const & context,
Implements implements,
com::sun::star::uno::Sequence< rtl::OUString > const & absentOptional,
com::sun::star::uno::Type const & type);
class Impl;
Impl * m_impl;
friend class Impl;
template< typename T > friend class PropertySetMixin;
~PropertySetMixinImpl();
void checkUnknown(rtl::OUString const & propertyName);
};
/**
@short A helper mixin to implement certain UNO interfaces related to property
set handling on top of the attributes of a given UNO interface type.
@descr The UNO interface type is specified by the type parameter
<code>T</code> (which must correspond to a UNO interface type).
@descr No specializations of this class template should be added by client
code.
@since UDK 3.2.1
*/
template< typename T > class PropertySetMixin: public PropertySetMixinImpl {
protected:
/**
@short The constructor.
@descr May throw <code>com::sun::star::uno::RuntimeException</code> and
<code>std::bad_alloc</code>.
@param context the component context used by this class template; must
not be null, and must supply the service
<code>com.sun.star.reflection.CoreReflection</code> and the singleton
<code>com.sun.star.reflection.theTypeDescriptionManager</code>
@param implements a combination of zero or more flags specifying what
UNO interface types shall be supported
@param absentOptional a list of optional properties that are not
present, and should thus not be visible via
<code>com::sun::star::beans::XPropertySet::getPropertySetInfo</code>,
<code>com::sun::star::beans::XPropertySet::addPropertyChangeListener<!--
--></code>, <code>com::sun::star::beans::XPropertySet::<!--
-->removePropertyChangeListener</code>,
<code>com::sun::star::beans::XPropertySet::addVetoableChangeListener<!--
--></code>, and <code>com::sun::star::beans::XPropertySet::<!--
-->removeVetoableChangeListener</code>. For consistency reasons, the
given <code>absentOptional</code> should only contain the names of
attributes that represent optional properties that are not present (that
is, the attribute getters and setters always throw a
<code>com::sun::star::beans::UnknownPropertyException</code>), and should
contain each such name only once. If an optional property is not present
(that is, the corresponding attribute getter and setter always throw a
<code>com::sun::star::beans::UnknownPropertyException</code>) but is not
contained in the given <code>absentOptional</code>, then it will be
visible via
<code>com::sun::star::beans::XPropertySet::getPropertySetInfo</code> as a
<code>com::sun::star::beans::Property</code> with a set
<code>com::sun::star::beans::PropertyAttribute::OPTIONAL</code>. If the
given <code>implements</code> specifies that
<code>com::sun::star::beans::XPropertySet</code> is not supported, then
the given <code>absentOptional</code> is effectively ignored and can be
empty.
*/
PropertySetMixin(
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >
const & context,
Implements implements,
com::sun::star::uno::Sequence< rtl::OUString > const & absentOptional):
PropertySetMixinImpl(
context, implements, absentOptional, T::static_type())
{}
/**
@short The destructor.
@descr Does not throw.
*/
~PropertySetMixin() {}
private:
PropertySetMixin(PropertySetMixin &); // not defined
void operator =(PropertySetMixin &); // not defined
};
#if defined _MSC_VER
#pragma warning(pop)
#endif
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|