sw/source/ui/vba/vbaformfield.cxx

   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 #include <ooo/vba/word/WdFieldType.hpp>
  11
  12 #include <sal/log.hxx>
  13
  14 #include <doc.hxx>
  15 #include <docsh.hxx>
  16 #include <unotextrange.hxx>
  17
  18 #include "vbaformfield.hxx"
  19 #include "vbaformfieldcheckbox.hxx"
  20 #include "vbaformfielddropdown.hxx"
  21 #include "vbaformfieldtextinput.hxx"
  22 #include "vbarange.hxx"
  23 #include "wordvbahelper.hxx"
  24
  25 using namespace ::ooo::vba;
  26 using namespace ::com::sun::star;
  27
  28 /**
  29  * FormFields are inline text objects that are only found in MS Word.
  30  * They cannot be created in Excel or in Calc.
  31  *
  32  * There are three specific kinds of FormFields: CheckBox, DropDown, and TextInput.
  33  */
  34 SwVbaFormField::SwVbaFormField(const uno::Reference<ooo::vba::XHelperInterface>& rParent,
  35                                const uno::Reference<uno::XComponentContext>& rContext,
  36                                const uno::Reference<text::XTextDocument>& xTextDocument,
  37                                sw::mark::IFieldmark& rFormField)
  38     : SwVbaFormField_BASE(rParent, rContext)
  39     , m_xTextDocument(xTextDocument)
  40     , m_rFormField(rFormField)
  41 {
  42 }
  43
  44 SwVbaFormField::~SwVbaFormField() {}
  45
  46 uno::Any SwVbaFormField::CheckBox()
  47 {
  48     return uno::Any(uno::Reference<word::XCheckBox>(
  49         new SwVbaFormFieldCheckBox(mxParent, mxContext, m_rFormField)));
  50 }
  51
  52 uno::Any SwVbaFormField::DropDown()
  53 {
  54     return uno::Any(uno::Reference<word::XDropDown>(
  55         new SwVbaFormFieldDropDown(mxParent, mxContext, m_rFormField)));
  56 }
  57
  58 uno::Any SwVbaFormField::TextInput()
  59 {
  60     return uno::Any(uno::Reference<word::XTextInput>(
  61         new SwVbaFormFieldTextInput(mxParent, mxContext, m_rFormField)));
  62 }
  63
  64 uno::Any SwVbaFormField::Previous()
  65 {
  66     SwDoc* pDoc = word::getDocShell(m_xTextDocument)->GetDoc();
  67     if (!pDoc)
  68         return uno::Any();
  69
  70     const IDocumentMarkAccess* pMarkAccess = pDoc->getIDocumentMarkAccess();
  71     if (!pMarkAccess)
  72         return uno::Any();
  73
  74     sw::mark::IFieldmark* pFieldMark = pMarkAccess->getFieldmarkBefore(m_rFormField.GetMarkPos(),
  75                                                                        /*bLoop=*/false);
  76
  77     // DateFields are a LO specialty, and do not exist natively in MS documents. Ignore if added...
  78     auto pDateField = dynamic_cast<sw::mark::IDateFieldmark*>(pFieldMark);
  79     while (pDateField)
  80     {
  81         pFieldMark = pMarkAccess->getFieldmarkBefore(pDateField->GetMarkPos(), /*bLoop=*/false);
  82         pDateField = dynamic_cast<sw::mark::IDateFieldmark*>(pFieldMark);
  83     }
  84
  85     if (!pFieldMark)
  86         return uno::Any();
  87
  88     return uno::Any(uno::Reference<word::XFormField>(
  89         new SwVbaFormField(mxParent, mxContext, m_xTextDocument, *pFieldMark)));
  90 }
  91
  92 uno::Any SwVbaFormField::Next()
  93 {
  94     SwDoc* pDoc = word::getDocShell(m_xTextDocument)->GetDoc();
  95     if (!pDoc)
  96         return uno::Any();
  97
  98     const IDocumentMarkAccess* pMarkAccess = pDoc->getIDocumentMarkAccess();
  99     if (!pMarkAccess)
 100         return uno::Any();
 101
 102     sw::mark::IFieldmark* pFieldMark = pMarkAccess->getFieldmarkAfter(m_rFormField.GetMarkPos(),
 103                                                                       /*bLoop=*/false);
 104
 105     // DateFields are a LO specialty, and do not exist natively in MS documents. Ignore if added...
 106     auto pDateField = dynamic_cast<sw::mark::IDateFieldmark*>(pFieldMark);
 107     while (pDateField)
 108     {
 109         pFieldMark = pMarkAccess->getFieldmarkAfter(pDateField->GetMarkPos(), /*bLoop=*/false);
 110         pDateField = dynamic_cast<sw::mark::IDateFieldmark*>(pFieldMark);
 111     }
 112
 113     if (!pFieldMark)
 114         return uno::Any();
 115
 116     return uno::Any(uno::Reference<word::XFormField>(
 117         new SwVbaFormField(mxParent, mxContext, m_xTextDocument, *pFieldMark)));
 118 }
 119
 120 uno::Reference<word::XRange> SwVbaFormField::Range()
 121 {
 122     uno::Reference<word::XRange> xRet;
 123     SwDoc* pDoc = word::getDocShell(m_xTextDocument)->GetDoc();
 124     if (pDoc)
 125     {
 126         uno::Reference<text::XTextRange> xText(SwXTextRange::CreateXTextRange(
 127             *pDoc, m_rFormField.GetMarkStart(), &m_rFormField.GetMarkEnd()));
 128         if (xText.is())
 129             xRet = new SwVbaRange(mxParent, mxContext, m_xTextDocument, xText->getStart(),
 130                                   xText->getEnd());
 131     }
 132     return xRet;
 133 }
 134
 135 OUString SwVbaFormField::getDefaultPropertyName() { return "Type"; }
 136
 137 sal_Int32 SwVbaFormField::getType()
 138 {
 139     IDocumentMarkAccess::MarkType aType = IDocumentMarkAccess::GetType(m_rFormField);
 140     if (aType == IDocumentMarkAccess::MarkType::CHECKBOX_FIELDMARK)
 141         return ooo::vba::word::WdFieldType::wdFieldFormCheckBox;
 142     else if (aType == IDocumentMarkAccess::MarkType::TEXT_FIELDMARK)
 143         return ooo::vba::word::WdFieldType::wdFieldFormTextInput;
 144     return ooo::vba::word::WdFieldType::wdFieldFormDropDown;
 145 }
 146
 147 sal_Bool SwVbaFormField::getCalculateOnExit()
 148 {
 149     SAL_INFO("sw.vba", "SwVbaFormField::getCalculateOnExit stub");
 150     return false;
 151 }
 152
 153 void SwVbaFormField::setCalculateOnExit(sal_Bool /*bSet*/)
 154 {
 155     SAL_INFO("sw.vba", "SwVbaFormField::setCalculateOnExit stub");
 156 }
 157
 158 sal_Bool SwVbaFormField::getEnabled()
 159 {
 160     SAL_INFO("sw.vba", "SwVbaFormField::getEnabled stub");
 161     return true;
 162 }
 163
 164 void SwVbaFormField::setEnabled(sal_Bool /*bSet*/)
 165 {
 166     SAL_INFO("sw.vba", "SwVbaFormField::setEnabled stub");
 167 }
 168
 169 OUString SwVbaFormField::getEntryMacro()
 170 {
 171     OUString sMacro;
 172     (*m_rFormField.GetParameters())["EntryMacro"] >>= sMacro;
 173     return sMacro;
 174 }
 175
 176 void SwVbaFormField::setEntryMacro(const OUString& rSet)
 177 {
 178     (*m_rFormField.GetParameters())["EntryMacro"] <<= rSet;
 179 }
 180
 181 OUString SwVbaFormField::getExitMacro()
 182 {
 183     OUString sMacro;
 184     (*m_rFormField.GetParameters())["ExitMacro"] >>= sMacro;
 185     return sMacro;
 186 }
 187
 188 void SwVbaFormField::setExitMacro(const OUString& rSet)
 189 {
 190     (*m_rFormField.GetParameters())["ExitMacro"] <<= rSet;
 191 }
 192
 193 OUString SwVbaFormField::getHelpText() { return m_rFormField.GetFieldHelptext(); }
 194
 195 void SwVbaFormField::setHelpText(const OUString& rSet) { m_rFormField.SetFieldHelptext(rSet); }
 196
 197 sal_Bool SwVbaFormField::getOwnHelp()
 198 {
 199     SAL_INFO("sw.vba", "SwVbaFormField::getOwnHelp stub");
 200     return true;
 201 }
 202
 203 void SwVbaFormField::setOwnHelp(sal_Bool /*bSet*/)
 204 {
 205     SAL_INFO("sw.vba", "SwVbaFormField::setOwnHelp stub");
 206 }
 207
 208 OUString SwVbaFormField::getName() { return m_rFormField.GetName(); }
 209
 210 void SwVbaFormField::setName(const OUString& rSet)
 211 {
 212     SAL_INFO("sw.vba", "SwVbaFormField::setName[" << rSet << "] stub");
 213 }
 214
 215 OUString SwVbaFormField::getResult() { return m_rFormField.GetContent(); }
 216
 217 void SwVbaFormField::setResult(const OUString& rSet)
 218 {
 219     if (dynamic_cast<sw::mark::ICheckboxFieldmark*>(&m_rFormField))
 220         m_rFormField.ReplaceContent("false");
 221     else
 222         m_rFormField.ReplaceContent(rSet);
 223 }
 224
 225 OUString SwVbaFormField::getStatusText()
 226 {
 227     SAL_INFO("sw.vba", "SwVbaFormField::getStatusText stub");
 228     return OUString();
 229 }
 230
 231 void SwVbaFormField::setStatusText(const OUString& rSet)
 232 {
 233     SAL_INFO("sw.vba", "SwVbaFormField::setStatusText[" << rSet << "] stub");
 234 }
 235
 236 sal_Bool SwVbaFormField::getOwnStatus()
 237 {
 238     SAL_INFO("sw.vba", "SwVbaFormField::getOwnStatus stub");
 239     return true;
 240 }
 241
 242 void SwVbaFormField::setOwnStatus(sal_Bool /*bSet*/)
 243 {
 244     SAL_INFO("sw.vba", "SwVbaFormField::setOwnStatus stub");
 245 }
 246
 247 OUString SwVbaFormField::getServiceImplName() { return "SwVbaFormField"; }
 248
 249 uno::Sequence<OUString> SwVbaFormField::getServiceNames()
 250 {
 251     static uno::Sequence<OUString> const aServiceNames{ "ooo.vba.word.FormField" };
 252     return aServiceNames;
 253 }
 254
 255 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */