offapi/com/sun/star/text/TextMarkupDescriptor.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
  20
  21
  22 module com {  module sun {  module star {  module text {
  23
  24
  25 /** A descriptor for a single text markup.
  26
  27     @since OOo 3.0.1
  28  */
  29
  30 struct TextMarkupDescriptor
  31 {
  32     /// Type of text markup see TextMarkupType
  33     long        nType;
  34
  35     /// A string used to identify the caller
  36     string      aIdentifier;
  37
  38     /// Start of the markup range
  39     long        nOffset;
  40
  41     /// Length of the markup range
  42     long        nLength;
  43
  44     /** contains additional information about the markup
  45
  46         Supported properties:
  47
  48         nType                     | aKey
  49         ------------------------- | -------------
  50         PROOFREADING or SMARTTAG  | "LineColor": changes the markup color from default to RGB aValue (int32)
  51         PROOFREADING or SMARTTAG  | "LineType": changes the underlining style to aValue (short): WAVE, DASH
  52                                   | @since 6.3: BOLDWAVE, BOLD
  53                                   | See: com::sun::star::awt::FontUnderline
  54     */
  55     com::sun::star::container::XStringKeyMap xMarkupInfoContainer;
  56 };
  57
  58 }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */