1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3*cdf0e10cSrcweir * 4*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 5*cdf0e10cSrcweir * 6*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 7*cdf0e10cSrcweir * 8*cdf0e10cSrcweir * This file is part of OpenOffice.org. 9*cdf0e10cSrcweir * 10*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 11*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 12*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 13*cdf0e10cSrcweir * 14*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 15*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 16*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 18*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 19*cdf0e10cSrcweir * 20*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 21*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 22*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 23*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 24*cdf0e10cSrcweir * 25*cdf0e10cSrcweir ************************************************************************/ 26*cdf0e10cSrcweir 27*cdf0e10cSrcweir #ifndef XMLOFF_PROPERTY_DESCRIPTION_HXX 28*cdf0e10cSrcweir #define XMLOFF_PROPERTY_DESCRIPTION_HXX 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir #include "forms/property_handler.hxx" 31*cdf0e10cSrcweir #include "property_group.hxx" 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir #include "xmloff/xmltoken.hxx" 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir #include <vector> 36*cdf0e10cSrcweir #include <list> 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir //...................................................................................................................... 39*cdf0e10cSrcweir namespace xmloff 40*cdf0e10cSrcweir { 41*cdf0e10cSrcweir //...................................................................................................................... 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir //================================================================================================================== 44*cdf0e10cSrcweir //= PropertyDescription 45*cdf0e10cSrcweir //================================================================================================================== 46*cdf0e10cSrcweir struct AttributeDescription 47*cdf0e10cSrcweir { 48*cdf0e10cSrcweir sal_uInt16 namespacePrefix; // usually XML_NAMESPACE_FORM 49*cdf0e10cSrcweir ::xmloff::token::XMLTokenEnum attributeToken; 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir AttributeDescription() 52*cdf0e10cSrcweir :namespacePrefix( 0 ) 53*cdf0e10cSrcweir ,attributeToken( ::xmloff::token::XML_TOKEN_INVALID ) 54*cdf0e10cSrcweir { 55*cdf0e10cSrcweir } 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir AttributeDescription( 58*cdf0e10cSrcweir const sal_uInt16 i_namespacePrefix, 59*cdf0e10cSrcweir const ::xmloff::token::XMLTokenEnum i_attributeToken 60*cdf0e10cSrcweir ) 61*cdf0e10cSrcweir :namespacePrefix( i_namespacePrefix ) 62*cdf0e10cSrcweir ,attributeToken( i_attributeToken ) 63*cdf0e10cSrcweir { 64*cdf0e10cSrcweir } 65*cdf0e10cSrcweir }; 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir //.................................................................................................................. 68*cdf0e10cSrcweir inline bool operator==( const AttributeDescription& i_lhs, const AttributeDescription& i_rhs ) 69*cdf0e10cSrcweir { 70*cdf0e10cSrcweir return ( i_lhs.namespacePrefix == i_rhs.namespacePrefix ) 71*cdf0e10cSrcweir && ( i_lhs.attributeToken == i_rhs.attributeToken ); 72*cdf0e10cSrcweir } 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir //================================================================================================================== 75*cdf0e10cSrcweir //= PropertyDescription 76*cdf0e10cSrcweir //================================================================================================================== 77*cdf0e10cSrcweir struct PropertyDescription 78*cdf0e10cSrcweir { 79*cdf0e10cSrcweir /// is the name of the property 80*cdf0e10cSrcweir const ::rtl::OUString propertyName; 81*cdf0e10cSrcweir /** denotes the attribute which represents the property. Note that multiple properties might comprise a single 82*cdf0e10cSrcweir attribute value. 83*cdf0e10cSrcweir */ 84*cdf0e10cSrcweir const AttributeDescription attribute; 85*cdf0e10cSrcweir /// is the factory for creating a handler for reading and writing the property 86*cdf0e10cSrcweir const PropertyHandlerFactory factory; 87*cdf0e10cSrcweir /// the unique ID of the property. The property meta data table must not contain two entries with the same property ID 88*cdf0e10cSrcweir const PropertyId propertyId; 89*cdf0e10cSrcweir /** the group which the property belongs to. Multiple properties belonging to the same group will, all together, 90*cdf0e10cSrcweir define the attribute value to be written into the ODF file. 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir Consequently, properties which have the same |propertyGroup| value must also have the same |attribute| 93*cdf0e10cSrcweir and the same |factory| value, with the only exception being NO_GROUP properties. 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir Note that the other direction is not given: It is perfectly legitimate to map the same attribute to different 96*cdf0e10cSrcweir (disjunct) property groups. 97*cdf0e10cSrcweir */ 98*cdf0e10cSrcweir const PropertyGroup propertyGroup; 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir PropertyDescription() 101*cdf0e10cSrcweir :propertyName() 102*cdf0e10cSrcweir ,attribute() 103*cdf0e10cSrcweir ,factory( NULL ) 104*cdf0e10cSrcweir ,propertyId( PID_INVALID ) 105*cdf0e10cSrcweir ,propertyGroup( NO_GROUP ) 106*cdf0e10cSrcweir { 107*cdf0e10cSrcweir } 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir PropertyDescription( 110*cdf0e10cSrcweir const ::rtl::OUString& i_propertyName, 111*cdf0e10cSrcweir const sal_uInt16 i_namespacePrefix, 112*cdf0e10cSrcweir const ::xmloff::token::XMLTokenEnum i_attributeToken, 113*cdf0e10cSrcweir const PropertyHandlerFactory i_factory, 114*cdf0e10cSrcweir const PropertyId i_propertyId, 115*cdf0e10cSrcweir const PropertyGroup i_propertyGroup 116*cdf0e10cSrcweir ) 117*cdf0e10cSrcweir :propertyName( i_propertyName ) 118*cdf0e10cSrcweir ,attribute( i_namespacePrefix, i_attributeToken ) 119*cdf0e10cSrcweir ,factory( i_factory ) 120*cdf0e10cSrcweir ,propertyId( i_propertyId ) 121*cdf0e10cSrcweir ,propertyGroup( i_propertyGroup ) 122*cdf0e10cSrcweir { 123*cdf0e10cSrcweir } 124*cdf0e10cSrcweir }; 125*cdf0e10cSrcweir 126*cdf0e10cSrcweir //================================================================================================================== 127*cdf0e10cSrcweir //= PropertyDescriptionList 128*cdf0e10cSrcweir //================================================================================================================== 129*cdf0e10cSrcweir typedef ::std::vector< const PropertyDescription* > PropertyDescriptionList; 130*cdf0e10cSrcweir 131*cdf0e10cSrcweir //================================================================================================================== 132*cdf0e10cSrcweir //= PropertyGroups 133*cdf0e10cSrcweir //================================================================================================================== 134*cdf0e10cSrcweir typedef ::std::list< PropertyDescriptionList > PropertyGroups; 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir //...................................................................................................................... 137*cdf0e10cSrcweir } // namespace xmloff 138*cdf0e10cSrcweir //...................................................................................................................... 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir #endif // XMLOFF_PROPERTY_DESCRIPTION_HXX 141