/************************************************************************* * * $RCSfile: DescriptionGenerator.hxx,v $ * * $Revision: 1.3 $ * * last change: $Author: af $ $Date: 2002-03-18 10:04:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library 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 for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef _SVX_ACCESSIBILITY_DESCRIPTION_GENERATOR_HXX #define _SVX_ACCESSIBILITY_DESCRIPTION_GENERATOR_HXX #ifndef _COM_SUN_STAR_DRAWING_XSHAPE_HPP_ #include #endif #ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_ #include #endif #ifndef _RTL_USTRBUF_HXX_ #include #endif namespace accessibility { /** This class creates description strings for shapes.

Initialized with a given shape additional calls to the addProperty method will build a descriptive string that starts with a general shape description and the shapes style. Appended are all the specified property names and values that differ from the default values in the style.

*/ class DescriptionGenerator { public: enum PropertyType { COLOR, INTEGER, STRING, FILL_STYLE }; /** Creates a new description generator with an empty description string. Usually you will want to call initialize next to specifiy a general description of the shape. @param xShape The shape from which properties will be extracted by later calls to addProperty. */ DescriptionGenerator (const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape>& xShape); ~DescriptionGenerator (void); /** Initialize the description with the given prefix followed by the shape's style in parantheses and a colon. @param sPrefix An introductory description of the shape that is made more specific by later calls to addProperty. */ void Initialize (::rtl::OUString sPrefix); /** Initialize the description with the specified string from the resource followed by the shape's style in parantheses and a colon. @param nResourceId A resource id the specifies the introductory description of the shape that is made more specific by later calls to addProperty. */ void Initialize (sal_Int32 nResourceId); /** Returns the description string and then resets it. Usually called as last method before destroying the object. @return The description string in its current form. */ ::rtl::OUString operator() (void); /** Add the given property name and its associated value to the description string. If the property value does not differ from the default value of the shape's style then the description string is not modified. @param sPropertyName The Name of the property to append. @param aType Type of the property's value. It controls the transformation into the value's string representation. @param sLocalizedName Localized name of the property. An empty string tells the method to use the property name instead. @param nWhichId This which id is used to localize the property value. If it is not known a value of -1 signals to use a default representation. */ void AddProperty (const ::rtl::OUString& sPropertyName, PropertyType aType, const ::rtl::OUString& sLocalizedName=::rtl::OUString(), long nWhichId=-1); /** Add the given property name and its associated value to the description string. If the property value does not differ from the default value of the shape's style then the description string is not modified. This method forwards the request to its cousing but first replaces the id of the localized name by the associated string from the resource. @param sPropertyName The Name of the property to append. @param aType Type of the property's value. It controls the transformation into the value's string representation. @param nResourceId Id of the kocalized name of the property int the resource. @param nWhichId This which id is used to localize the property value. If it is not known a value of -1 signals to use a default representation. */ void AddProperty (const ::rtl::OUString& sPropertyName, PropertyType aType, sal_Int32 nResourceId, long nWhichId=-1); /** Append the given string as is to the current description. @param sString String to append to the current description. It is not modified in any way. */ void AppendString (const ::rtl::OUString& sString); /** This method adds for debuging and development the list of all known properties to the description. Don't use in production code. */ void AddPropertyNames (void); /** Add properties that describe line and border attributes. */ void AddLineProperties (void); /** Add properties that describe how areas are filled. */ void AddFillProperties (void); /** Add properties that describesattributes of 3D objects. */ void Add3DProperties (void); /** Add properties that describe text attributes. */ void AddTextProperties (void); private: /// Reference to the shape from which the properties are extracted. ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape> mxShape; /// Reference to the shape's property set. ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet> mxSet; /// The description string that is build. ::rtl::OUStringBuffer msDescription; /** This flag is used to determine whether to insert a separator e.g. a comma before the next property. */ bool mbIsFirstProperty; /** Add a property value formated as color to the description string. */ void AddColor (const ::rtl::OUString& sPropertyName, const ::rtl::OUString& sLocalizedName); /** Add a property value of unknown type to the description string. */ void AddUnknown (const ::rtl::OUString& sPropertyName, const ::rtl::OUString& sLocalizedName); /** Add a property value formated as integer to the description string. */ void AddInteger (const ::rtl::OUString& sPropertyName, const ::rtl::OUString& sLocalizedName); /** Add a property value formated as string to the description string. @param sPropertyName Name of the property. */ void AddString (const ::rtl::OUString& sPropertyName, const ::rtl::OUString& sLocalizedName, long nWhichId = -1); /** Add a property value formated as fill style to the description string. If the fill style is HATCH, GRADIENT, or BITMAP, then the of the hatch, gradient, or bitmap is appended as well. @param sPropertyName Name of the property. Usually this will be "FillStyle". */ void AddFillStyle (const ::rtl::OUString& sPropertyName, const ::rtl::OUString& sLocalizedName); }; } // end of namespace accessibility #endif