/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: PropertyCategoryDescriptor.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: vg $ $Date: 2006-03-31 12:02:59 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#ifndef __com_sun_star_inspection_PropertyCategoryDescriptor_idl__
#define __com_sun_star_inspection_PropertyCategoryDescriptor_idl__

//=============================================================================
module com {  module sun {  module star {  module inspection {

//-----------------------------------------------------------------------------
/** describes a category of properties
    @see ObjectInspector
    @see XObjectInspectorModel::describeCategory
    @see LineDescriptor::Category

    @since OOo 2.0.3
*/
struct PropertyCategoryDescriptor
{
    /** contains the programmatic name of the category.

        <p>This programmatic name is used internally: <member>XPropertyHandler::describePropertyLine</member>
        sets a programmatic category name at <member>LineDescriptor::Category</member>,
        and an object inspector uses this to find the proper <type>PropertyCategoryDescriptor</type>.</p>
    */
    string  ProgrammaticName;

    /** provides a human-readable name (which can be presented at the UI) for a category.
    */
    string UIName;

    /** provides a help URL to be associated with a category
    */
    string HelpURL;
};

//=============================================================================

}; }; }; };

#endif



