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

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