oovbaapi/ooo/vba/word/XFormField.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 module ooo {  module vba {  module word {
  21
  22 interface XRange;
  23 interface XFormField
  24 {
  25     interface ooo::vba::XHelperInterface;
  26     interface com::sun::star::script::XDefaultProperty;
  27
  28     /// Default member: returns the field type from WdFieldType
  29     [attribute, readonly] long Type;
  30
  31     /**
  32      * Returns or sets true if references to the specified form field
  33      * are automatically updated whenever the field is exited.
  34      */
  35     [attribute] boolean CalculateOnExit;
  36     /// Returns or sets a string that represents the result of the specified form field
  37     [attribute] string Result;
  38     /// Returns or sets true if a form field is enabled
  39     [attribute] boolean Enabled;
  40     /// Returns or sets the macro name that runs on keyboard (tab) navigation into the field
  41     [attribute] string EntryMacro;
  42     /// Returns or sets an exit macro name that runs on keyboard (tab) navigation out of the field
  43     [attribute] string ExitMacro;
  44     /**
  45      * Returns or sets the text that's displayed in a message box
  46      * when the form field has the focus and the user presses F1.
  47      *
  48      * When OwnHelp is False, HelpText specifies the name of an AutoText entry
  49      * that contains help text for the form field
  50      */
  51     [attribute] string HelpText;
  52     /**
  53      * Returns or sets the specifies the source of the F1 text that's displayed in a message box
  54      * If True, the text specified by the HelpText property is displayed.
  55      * If False, the text in the AutoText entry specified by the HelpText property is displayed.
  56      */
  57     [attribute] boolean OwnHelp;
  58     /// returns or sets the name of the specified object.
  59     [attribute] string Name;
  60     /// Returns or sets the text that is displayed in the status bar when a form field has the focus
  61     [attribute] string StatusText;
  62     /** OwnStatus:
  63      * If True, the text specified by the StatusText property is displayed.
  64      * If False, the text of the AutoText entry specified by the StatusText property is displayed.
  65      */
  66     [attribute] boolean OwnStatus;
  67
  68     any CheckBox();
  69     any DropDown();
  70     any TextInput();
  71     /// Returns the next form field in the collection.
  72     any Next();
  73     /// returns the previous form field in the collection.
  74     any Previous();
  75     /**
  76      * Represents a contiguous area in a document.
  77      * Each Range object is defined by a starting and ending character position.
  78      */
  79     XRange Range();
  80 };
  81
  82 }; }; };
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */