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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_inspection_PropertyCategoryDescriptor_idl__
  20 #define __com_sun_star_inspection_PropertyCategoryDescriptor_idl__
  21
  22 module com {  module sun {  module star {  module inspection {
  23
  24 /** describes a category of properties
  25     @see ObjectInspector
  26     @see XObjectInspectorModel::describeCategory
  27     @see LineDescriptor::Category
  28
  29     @since OOo 2.0.3
  30 */
  31 struct PropertyCategoryDescriptor
  32 {
  33     /** contains the programmatic name of the category.
  34
  35         <p>This programmatic name is used internally: XPropertyHandler::describePropertyLine()
  36         sets a programmatic category name at LineDescriptor::Category,
  37         and an object inspector uses this to find the proper PropertyCategoryDescriptor.</p>
  38     */
  39     string  ProgrammaticName;
  40
  41     /** provides a human-readable name (which can be presented at the UI) for a category.
  42     */
  43     string UIName;
  44
  45     /** provides a help URL to be associated with a category
  46     */
  47     string HelpURL;
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */