oovbaapi/ooo/vba/word/XContentControl.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
  10 module ooo {  module vba {  module word {
  11
  12 interface XRange;
  13 interface XContentControlListEntries;
  14 interface XContentControl
  15 {
  16     interface ooo::vba::XHelperInterface;
  17
  18     /// returns or sets whether users can add/remove sections from the specified repeating section
  19     /// content control by using the user interface.
  20     /// Use only with repeating section content controls.
  21     [attribute] boolean AllowInsertDeleteSection;
  22     /// returns or sets the appearance of the content control.
  23     /// (wdContentControlBoundingBox/wdContentControlHidden/wdContentControlTags)
  24     [attribute] long Appearance;
  25     /// returns or sets a String that represents the category for a building block content control.
  26     [attribute] string BuildingBlockCategory;
  27     /// returns or sets a WdBuildingBlockTypes constant that represents the type of building block
  28     /// for a building block content control.
  29     [attribute] long BuildingBlockType;
  30     /// returns or sets a Boolean that represents a check box's current state (checked/unchecked).
  31     [attribute] boolean Checked;
  32     /// returns or sets the color of the content control.
  33     [attribute] long Color;
  34     /// returns or sets a WdCalendarType constant that represents the calendar type.
  35     [attribute] long DateCalendarType;
  36     /// returns or sets a String that represents the format in which dates are displayed.
  37     [attribute] string DateDisplayFormat;
  38     /// returns a WdLanguageID that represents the language format for the date displayed.
  39     [attribute, readonly] long DateDisplayLocale;
  40     /// returns or sets a WdContentControlDateStorageFormat that represents the format for storage
  41     /// and retrieval of dates when a date content control is bound to the XML data store.
  42     [attribute] long DateStorageFormat;
  43     /// returns or sets a Variant that represents the name of the character style to use to format text in a text content control.
  44     //[attribute] string DefaultTextStyle;
  45     /// returns a ContentControlListEntries collection that represents the items
  46     /// in a drop-down list content control or in a combo box content control.
  47     [attribute, readonly] any DropdownListEntries;
  48     /// returns a String that represents the identification for a content control.
  49     [attribute, readonly] string ID;
  50     /// returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.
  51     /// (wdContentControlLevelCell/wdContentControlLevelInline/wdContentControlLevelParagraph/wdContentControlLevelRow)
  52     [attribute, readonly] long Level;
  53     /// returns or sets whether the user can delete a content control from the active document.
  54     [attribute] boolean LockContentControl;
  55     /// returns or sets whether the user can edit the contents of a content control.
  56     [attribute] boolean LockContents;
  57     /// returns or sets whether a text content control allows multiple lines of text.
  58     [attribute] boolean MultiLine;
  59     /// returns a ContentControl that represents the parent content control for a content control that is nested inside a rich-text control or group control.
  60     //[attribute, readonly] XContentControl ParentContentControl;
  61     /// returns a BuildingBlock object that represents the placeholder text for a content control.
  62     [attribute, readonly] /*WRONG - should be XBuildingBlock*/ string PlaceholderText;
  63     /// returns a Range that represents the contents of the content control in the active document.
  64     [attribute, readonly] XRange Range;
  65     /// returns the collection of repeating section items in the specified repeating section content control.
  66     //[attribute, readonly] RepeatingSectionItems;
  67     /// returns or sets the name of the repeating section items used in the context menu associated
  68     /// with the specified repeating section content control.
  69     [attribute] string RepeatingSectionItemTitle;
  70     /// returns whether the placeholder text for the content control is displayed.
  71     [attribute, readonly] boolean ShowingPlaceholderText;
  72     /// returns or sets a String that represents a value to identify a content control.
  73     [attribute] string Tag;
  74     /// returns or sets whether to remove a content control from the active document
  75     /// when the user edits the contents of the control.
  76     [attribute] boolean Temporary;
  77     /// returns or sets a String that represents the title for a content control.
  78     [attribute] string Title;
  79     /// returns or sets a WdContentControlType that represents the type for a content control.
  80     [attribute] long Type;
  81     /// returns an XMLMapping object that represents the mapping of a content control to XML data in the data store of a document.
  82     //[attribute, readonly] XMLMapping;
  83
  84     /// Copies the content control from the active document to the Clipboard.
  85     void Copy();
  86     /// Removes the content control from the active document and moves it to the Clipboard.
  87     void Cut();
  88     /// Deletes the specified content control and the contents of the content control.
  89     void Delete( [in] /*optional*/ any bDeleteContents );
  90     /// Sets the symbol used to represent the checked state of a check box content control.
  91     void SetCheckedSymbol( [in] long Character, [in] /*optional*/ any sFont );
  92     /// Sets the symbol used to represent the unchecked state of a check box content control.
  93     void SetUnCheckedSymbol( [in] long Character, [in] /*optional*/ any sFont );
  94     /// Sets the placeholder text that displays until a user enters their own text.
  95     void SetPlaceholderText( [in] /*optional*/ any BuildingBlock, [in] /*optional*/ any Range, [in] /*optional*/ any sFont );
  96     /// Removes a group content control. Its children are no longer nested and can be freely edited.
  97     void Ungroup();
  98
  99 };
 100
 101 }; }; };
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */