offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_inspection_PropertyCategoryDescriptor_idl__
  28 #define __com_sun_star_inspection_PropertyCategoryDescriptor_idl__
  29
  30 //=============================================================================
  31 module com {  module sun {  module star {  module inspection {
  32
  33 //-----------------------------------------------------------------------------
  34 /** describes a category of properties
  35     @see ObjectInspector
  36     @see XObjectInspectorModel::describeCategory
  37     @see LineDescriptor::Category
  38
  39     @since OOo 2.0.3
  40 */
  41 struct PropertyCategoryDescriptor
  42 {
  43     /** contains the programmatic name of the category.
  44
  45         <p>This programmatic name is used internally: <member>XPropertyHandler::describePropertyLine</member>
  46         sets a programmatic category name at <member>LineDescriptor::Category</member>,
  47         and an object inspector uses this to find the proper <type>PropertyCategoryDescriptor</type>.</p>
  48     */
  49     string  ProgrammaticName;
  50
  51     /** provides a human-readable name (which can be presented at the UI) for a category.
  52     */
  53     string UIName;
  54
  55     /** provides a help URL to be associated with a category
  56     */
  57     string HelpURL;
  58 };
  59
  60 //=============================================================================
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66
  67