summaryrefslogtreecommitdiffstats
path: root/sw/source/ui/vba/vbaformfielddropdown.cxx
blob: f1edc8140357ae119699c516011ac38ea9cc28d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#include <ooo/vba/word/WdTextFormFieldType.hpp>

#include "vbaformfielddropdown.hxx"
#include "vbaformfielddropdownlistentries.hxx"

using namespace ::ooo::vba;
using namespace ::com::sun::star;

/**
 * DropDown formfields are inline text objects that are only found in MS Word.
 * They cannot be created in Excel or in Calc.
 *
 * Note that VBA might call this a DropDown, but it might not actually be one,
 * so make good use of getValid()
 */
SwVbaFormFieldDropDown::SwVbaFormFieldDropDown(
    const uno::Reference<ooo::vba::XHelperInterface>& rParent,
    const uno::Reference<uno::XComponentContext>& rContext, ::sw::mark::IFieldmark& rFormField)
    : SwVbaFormFieldDropDown_BASE(rParent, rContext)
    , m_pDropDown(dynamic_cast<sw::mark::IDropdownFieldmark*>(&rFormField))
{
}

SwVbaFormFieldDropDown::~SwVbaFormFieldDropDown() {}

OUString SwVbaFormFieldDropDown::getDefaultPropertyName() { return "Valid"; }

sal_Bool SwVbaFormFieldDropDown::getValid()
{
    return m_pDropDown
           && IDocumentMarkAccess::GetType(*m_pDropDown)
                  == IDocumentMarkAccess::MarkType::DROPDOWN_FIELDMARK;
}

sal_Int32 SwVbaFormFieldDropDown::getDefault() { return getValue(); }

void SwVbaFormFieldDropDown::setDefault(sal_Int32 nSet)
{
    // Hard to know what to do here, since LO doesn't have a default property for DropDowns.
    // Setting this really only makes sense when macro-adding a DropDown.
    // In that case, we want it to affect the actual text content.
    // However, if an item has already been selected by the user, then this shouldn't do anything.
    // Assuming this is only ever set when adding a DropDown seems the sanest approach.
    setValue(nSet);
}

sal_Int32 SwVbaFormFieldDropDown::getValue()
{
    sal_Int32 nRet = 0;
    if (!getValid())
        return nRet;

    --nRet; // send -1, which requests being changed to the selected DropDown's zero-based index
    m_pDropDown->GetContent(&nRet);
    return nRet + 1;
}

void SwVbaFormFieldDropDown::setValue(sal_Int32 nIndex)
{
    if (!getValid() || nIndex == getValue())
        return;

    // switch to zero-based index for implementation
    --nIndex;
    m_pDropDown->ReplaceContent(/*pText=*/nullptr, &nIndex);
}

uno::Any SwVbaFormFieldDropDown::ListEntries(const uno::Any& rIndex)
{
    if (!getValid())
        return uno::Any();

    uno::Reference<XCollection> xCol(
        new SwVbaFormFieldDropDownListEntries(this, mxContext, *m_pDropDown));

    if (rIndex.hasValue())
        return xCol->Item(rIndex, uno::Any());

    return uno::Any(xCol);
}

OUString SwVbaFormFieldDropDown::getServiceImplName() { return "SwVbaFormFieldDropDown"; }

uno::Sequence<OUString> SwVbaFormFieldDropDown::getServiceNames()
{
    static uno::Sequence<OUString> const aServiceNames{ "ooo.vba.word.DropDown" };
    return aServiceNames;
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */