xref: /trunk/main/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl (revision d695a2a0)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#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 OpenOffice 2.0.3
*/
published 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