1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_inspection_PropertyCategoryDescriptor_idl__
24#define __com_sun_star_inspection_PropertyCategoryDescriptor_idl__
25
26//=============================================================================
27module com {  module sun {  module star {  module inspection {
28
29//-----------------------------------------------------------------------------
30/** describes a category of properties
31    @see ObjectInspector
32    @see XObjectInspectorModel::describeCategory
33    @see LineDescriptor::Category
34
35    @since OpenOffice 2.0.3
36*/
37published struct PropertyCategoryDescriptor
38{
39    /** contains the programmatic name of the category.
40
41        <p>This programmatic name is used internally: <member>XPropertyHandler::describePropertyLine</member>
42        sets a programmatic category name at <member>LineDescriptor::Category</member>,
43        and an object inspector uses this to find the proper <type>PropertyCategoryDescriptor</type>.</p>
44    */
45    string  ProgrammaticName;
46
47    /** provides a human-readable name (which can be presented at the UI) for a category.
48    */
49    string UIName;
50
51    /** provides a help URL to be associated with a category
52    */
53    string HelpURL;
54};
55
56//=============================================================================
57
58}; }; }; };
59
60#endif
61
62
63
64