xmloff/inc/xmlbahdl.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <xmloff/xmlprhdl.hxx>
  23 #include <xmloff/xmltoken.hxx>
  24
  25
  26 /**
  27     PropertyHandler for the XML-data-type: XML_TYPE_NUMBER
  28 */
  29 class XMLNumberPropHdl : public XMLPropertyHandler
  30 {
  31     sal_Int8 nBytes;
  32
  33 public:
  34     explicit XMLNumberPropHdl( sal_Int8 nB ) : nBytes( nB ) {}
  35     virtual ~XMLNumberPropHdl() override;
  36
  37     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  38     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  39 };
  40
  41 /**
  42     PropertyHandler for the XML-data-type: XML_TYPE_NUMBER_NONE
  43 */
  44 class XMLNumberNonePropHdl : public XMLPropertyHandler
  45 {
  46     OUString sZeroStr;
  47     sal_Int8        nBytes;
  48 public:
  49     explicit XMLNumberNonePropHdl( sal_Int8 nB = 4 );
  50     XMLNumberNonePropHdl( enum ::xmloff::token::XMLTokenEnum eZeroString, sal_Int8 nB );
  51     virtual ~XMLNumberNonePropHdl() override;
  52
  53     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  54     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  55 };
  56
  57 /**
  58     PropertyHandler for the XML-data-type: XML_TYPE_MEASURE
  59 */
  60 class XMLMeasurePropHdl : public XMLPropertyHandler
  61 {
  62     sal_Int8 nBytes;
  63 public:
  64     explicit XMLMeasurePropHdl( sal_Int8 nB ) : nBytes( nB ) {}
  65     virtual ~XMLMeasurePropHdl() override;
  66
  67     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  68     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  69 };
  70
  71 /**
  72     PropertyHandler for the XML-data-type: XML_TYPE_UNIT_MEASURE
  73 */
  74 class XMLUnitMeasurePropHdl : public XMLPropertyHandler
  75 {
  76 public:
  77     bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  78     bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  79 };
  80
  81 /**
  82     PropertyHandler for the XML-data-type: XML_TYPE_PERCENT
  83 */
  84 class XMLPercentPropHdl : public XMLPropertyHandler
  85 {
  86     sal_Int8 nBytes;
  87 public:
  88     explicit XMLPercentPropHdl( sal_Int8 nB ) : nBytes( nB ) {}
  89     virtual ~XMLPercentPropHdl() override;
  90
  91     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  92     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
  93 };
  94
  95 /**
  96     PropertyHandler for the XML-data-type: XML_TYPE_PERCENT
  97     that is mapped on a double from 0.0 to 1.0
  98 */
  99 class XMLDoublePercentPropHdl : public XMLPropertyHandler
 100 {
 101     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 102     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 103 };
 104
 105 /// Maps between XML percentage and our 100th percent ints.
 106 class XML100thPercentPropHdl : public XMLPropertyHandler
 107 {
 108     virtual bool importXML(const OUString& rStrImpValue, css::uno::Any& rValue,
 109                            const SvXMLUnitConverter& rUnitConverter) const override;
 110     virtual bool exportXML(OUString& rStrExpValue, const css::uno::Any& rValue,
 111                            const SvXMLUnitConverter& rUnitConverter) const override;
 112 };
 113
 114 /**
 115     PropertyHandler for the XML-data-type: XML_TYPE_NEG_PERCENT
 116 */
 117 class XMLNegPercentPropHdl : public XMLPropertyHandler
 118 {
 119     sal_Int8 nBytes;
 120 public:
 121     explicit XMLNegPercentPropHdl( sal_Int8 nB ) : nBytes( nB ) {}
 122     virtual ~XMLNegPercentPropHdl() override;
 123
 124     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 125     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 126 };
 127
 128 /**
 129     PropertyHandler for the XML-data-type: XML_TYPE_PERCENT
 130 */
 131 class XMLMeasurePxPropHdl : public XMLPropertyHandler
 132 {
 133     sal_Int8 nBytes;
 134 public:
 135     explicit XMLMeasurePxPropHdl( sal_Int8 nB ) : nBytes( nB ) {}
 136     virtual ~XMLMeasurePxPropHdl() override;
 137
 138     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 139     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 140 };
 141
 142 /**
 143     PropertyHandler for the XML-data-type: XML_TYPE_BOOL
 144 */
 145 class XMLBoolPropHdl : public XMLPropertyHandler
 146 {
 147 public:
 148     virtual ~XMLBoolPropHdl() override;
 149
 150     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 151     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 152 };
 153
 154 class XMLBoolFalsePropHdl : public XMLBoolPropHdl
 155 {
 156 public:
 157     virtual ~XMLBoolFalsePropHdl() override;
 158
 159     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 160     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 161
 162 };
 163
 164 /**
 165     PropertyHandler for the XML-data-type: XML_TYPE_COLOR
 166 */
 167 class XMLColorPropHdl : public XMLPropertyHandler
 168 {
 169 public:
 170     virtual ~XMLColorPropHdl() override;
 171
 172     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 173     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 174 };
 175
 176 /**
 177     PropertyHandler for the XML-data-type: XML_TYPE_HEX
 178 */
 179 class XMLHexPropHdl : public XMLPropertyHandler
 180 {
 181 public:
 182     virtual ~XMLHexPropHdl() override;
 183
 184     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 185     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 186 };
 187
 188 /**
 189     PropertyHandler for the XML-data-type: XML_TYPE_STRING
 190 */
 191 class XMLStringPropHdl : public XMLPropertyHandler
 192 {
 193 public:
 194     virtual ~XMLStringPropHdl() override;
 195
 196     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 197     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 198 };
 199
 200 /**
 201     PropertyHandler for the XML-data-type: XML_TYPE_STYLENAME
 202 */
 203 class XMLStyleNamePropHdl : public XMLStringPropHdl
 204 {
 205 public:
 206     virtual ~XMLStyleNamePropHdl() override;
 207
 208     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 209 };
 210
 211
 212 /**
 213     PropertyHandler for the XML-data-type: XML_TYPE_DOUBLE
 214 */
 215 class XMLDoublePropHdl : public XMLPropertyHandler
 216 {
 217 public:
 218     virtual ~XMLDoublePropHdl() override;
 219
 220     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 221     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 222 };
 223
 224 /**
 225     PropertyHandler for the XML-data-type: XML_TYPE_NBOOL
 226 */
 227 class XMLNBoolPropHdl : public XMLPropertyHandler
 228 {
 229 public:
 230     virtual ~XMLNBoolPropHdl() override;
 231
 232     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 233     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 234 };
 235
 236 /**
 237     PropertyHandler for the XML-data-type: XML_TYPE_COLORTRANSPARENT
 238 */
 239 class XMLColorTransparentPropHdl : public XMLPropertyHandler
 240 {
 241     const OUString sTransparent;
 242
 243 public:
 244     explicit XMLColorTransparentPropHdl( enum ::xmloff::token::XMLTokenEnum eTransparent = xmloff::token::XML_TOKEN_INVALID );
 245     virtual ~XMLColorTransparentPropHdl() override;
 246
 247     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 248     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 249 };
 250
 251 /**
 252     PropertyHandler for the XML-data-type: XML_TYPE_ISTRANSPARENT
 253 */
 254 class XMLIsTransparentPropHdl : public XMLPropertyHandler
 255 {
 256     const OUString sTransparent;
 257     bool bTransPropValue;
 258
 259 public:
 260     XMLIsTransparentPropHdl( enum ::xmloff::token::XMLTokenEnum eTransparent = xmloff::token::XML_TOKEN_INVALID,
 261                              bool bTransPropValue = true );
 262     virtual ~XMLIsTransparentPropHdl() override;
 263
 264     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 265     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 266 };
 267
 268 /**
 269     PropertyHandler for the XML-data-type: XML_TYPE_COLORAUTO
 270 */
 271 class XMLColorAutoPropHdl : public XMLPropertyHandler
 272 {
 273 public:
 274     XMLColorAutoPropHdl();
 275     virtual ~XMLColorAutoPropHdl() override;
 276
 277     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 278     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 279 };
 280
 281 /**
 282     PropertyHandler for the XML-data-type: XML_TYPE_COLORISAUTO
 283 */
 284 class XMLIsAutoColorPropHdl : public XMLPropertyHandler
 285 {
 286 public:
 287     XMLIsAutoColorPropHdl();
 288     virtual ~XMLIsAutoColorPropHdl() override;
 289
 290     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 291     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 292 };
 293
 294
 295 /**
 296     PropertyHandler for properties that cannot make use of importXML
 297     and exportXML methods, but can make use of the default comparison
 298 */
 299 class XMLCompareOnlyPropHdl : public XMLPropertyHandler
 300 {
 301 public:
 302     virtual ~XMLCompareOnlyPropHdl() override;
 303
 304     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 305     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 306 };
 307
 308 /**
 309     PropertyHandler for the XML-data-type: XML_TYPE_NUMBER_NO_ZERO
 310     Reads/writes numeric properties, but fails for the value zero
 311     (i.e., a value 0 property will not be written)
 312 */
 313 class XMLNumberWithoutZeroPropHdl : public XMLPropertyHandler
 314 {
 315     sal_Int8        nBytes;
 316 public:
 317     explicit XMLNumberWithoutZeroPropHdl( sal_Int8 nB );
 318     virtual ~XMLNumberWithoutZeroPropHdl() override;
 319
 320     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 321     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const override;
 322 };
 323
 324 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */