sw/source/ui/vba/vbaformfieldtextinput.hxx

   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 #pragma once
  10
  11 #include <ooo/vba/word/XTextInput.hpp>
  12
  13 #include <vbahelper/vbahelperinterface.hxx>
  14
  15 #include <IDocumentMarkAccess.hxx>
  16
  17 typedef InheritedHelperInterfaceWeakImpl<ooo::vba::word::XTextInput> SwVbaFormFieldTextInput_BASE;
  18
  19 class SwVbaFormFieldTextInput : public SwVbaFormFieldTextInput_BASE
  20 {
  21 private:
  22     sw::mark::IFieldmark& m_rTextInput;
  23
  24 public:
  25     /// @throws css::uno::RuntimeException
  26     SwVbaFormFieldTextInput(const css::uno::Reference<ooo::vba::XHelperInterface>& rParent,
  27                             const css::uno::Reference<css::uno::XComponentContext>& rContext,
  28                             sw::mark::IFieldmark& rFormField);
  29     ~SwVbaFormFieldTextInput() override;
  30
  31     // XTextInput
  32     OUString SAL_CALL getDefaultPropertyName() override;
  33
  34     // default member: True if the specified form field object is a valid text form field
  35     sal_Bool SAL_CALL getValid() override;
  36
  37     // Returns and sets the default text string of the input box
  38     OUString SAL_CALL getDefault() override;
  39     void SAL_CALL setDefault(const OUString& bSet) override;
  40     // Returns the format string for the current text
  41     OUString SAL_CALL getFormat() override;
  42     /*
  43      * Returns the type of text form field.
  44      * Possible return values are:
  45      * wdCalculationText - Calculation text field,
  46      * wdCurrentDateText - Current date text field,
  47      * wdCurrentTimeText - Current time text field,
  48      * wdDateText - Date text field,
  49      * wdNumberText - Number text field,
  50      * wdRegularText - Regular text field.
  51      */
  52     sal_Int32 SAL_CALL getType() override;
  53     // Returns and sets the width, in points
  54     sal_Int32 SAL_CALL getWidth() override;
  55     void SAL_CALL setWidth(sal_Int32 nSet) override;
  56
  57     // Deletes the text from the text form field.
  58     void SAL_CALL Clear() override;
  59     // Sets the type, default text string, format string, and enabled status
  60     void SAL_CALL EditType(sal_Int32 nType, const css::uno::Any& rDefault,
  61                            const css::uno::Any& rFormat, const css::uno::Any& rEnabled) override;
  62
  63     // XHelperInterface
  64     OUString getServiceImplName() override;
  65     css::uno::Sequence<OUString> getServiceNames() override;
  66 };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */