sw/inc/flddropdown.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef _FLDDROPDOWN_HXX
  28 #define _FLDDROPDOWN_HXX
  29
  30 #ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX
  31 #include "com/sun/star/uno/Sequence.hxx"
  32 #endif
  33 #include "swdllapi.h"
  34 #include "fldbas.hxx"
  35
  36 #ifndef INCLUDED_VECTOR
  37 #include <vector>
  38 #define INCLUDED_VECTOR
  39 #endif
  40
  41 /**
  42     Field type for dropdown boxes.
  43 */
  44 class SwDropDownFieldType : public SwFieldType
  45 {
  46 public:
  47     /**
  48        Constructor
  49     */
  50     SwDropDownFieldType();
  51
  52     /**
  53        Destructor
  54     */
  55     virtual ~SwDropDownFieldType();
  56
  57     /**
  58        Create a copy of this field type.
  59
  60        @return a copy of this type
  61     */
  62     virtual SwFieldType * Copy () const;
  63 };
  64
  65 /**
  66    Dropdown field.
  67
  68    The dropdown field contains a list of strings. At most one of them
  69    can be selected.
  70 */
  71 class SW_DLLPUBLIC SwDropDownField : public SwField
  72 {
  73     /**
  74        the possible values (aka items) of the dropdown box
  75     */
  76     std::vector<String> aValues;
  77
  78     /**
  79       the selected item
  80     */
  81     String aSelectedItem;
  82
  83     /**
  84       the name of the field
  85     */
  86     String aName;
  87
  88     /**
  89        help text
  90      */
  91     String aHelp;
  92
  93     /**
  94        tool tip string
  95      */
  96     String aToolTip;
  97
  98 public:
  99     /**
 100        Constructor
 101
 102        @param pTyp field type for this field
 103     */
 104     SwDropDownField(SwFieldType * pTyp);
 105
 106     /**
 107        Copy constructor
 108
 109        @param rSrc dropdown field to copy
 110     */
 111     SwDropDownField(const SwDropDownField & rSrc);
 112
 113     /**
 114        Destructor
 115     */
 116     virtual ~SwDropDownField();
 117
 118     /**
 119        Expands the field.
 120
 121        The expanded value of the field is the value of the selected
 122        item. If no item is selected, an empty string is returned.
 123
 124        @return the expanded value of the field
 125     */
 126     virtual String Expand() const;
 127
 128     /**
 129        Creates a copy of this field.
 130
 131        @return the copy of this field
 132     */
 133     virtual SwField * Copy() const;
 134
 135     /**
 136        Returns the selected value.
 137
 138        @see Expand
 139
 140        @return the selected value
 141     */
 142     virtual const String & GetPar1() const;
 143
 144     /**
 145        Returns the name of the field.
 146
 147        @return the name of the field
 148     */
 149     virtual String GetPar2() const;
 150
 151     /**
 152        Sets the selected value.
 153
 154        If rStr is an item of the field that item will be
 155        selected. Otherwise no item will be selected, i.e. the
 156        resulting selection will be empty.
 157     */
 158     virtual void SetPar1(const String & rStr);
 159
 160     /**
 161        Sets the name of the field.
 162
 163        @param rStr the new name of the field
 164     */
 165     virtual void SetPar2(const String & rStr);
 166
 167     /**
 168        Sets the items of the dropdown box.
 169
 170        After setting the items the selection will be empty.
 171
 172        @param rItems the new items
 173     */
 174     void SetItems(const std::vector<String> & rItems);
 175
 176     /**
 177        Sets the items of the dropdown box.
 178
 179        After setting the items the selection will be empty.
 180
 181        @param rItems the new items
 182     */
 183     void SetItems(const com::sun::star::uno::Sequence<rtl::OUString> & rItems);
 184
 185     /**
 186         Returns the items of the dropdown box.
 187
 188         @return the items of the dropdown box
 189     */
 190     com::sun::star::uno::Sequence<rtl::OUString> GetItemSequence() const;
 191
 192     /**
 193        Returns the selected item.
 194
 195        @return the selected item
 196     */
 197     const String & GetSelectedItem() const;
 198
 199     /**
 200        Returns the name of the field.
 201
 202        @return the name of the field
 203     */
 204     const String & GetName() const;
 205
 206     /**
 207        Returns the help text of the field.
 208
 209        @return the help text of the field
 210     */
 211     const String & GetHelp() const;
 212
 213     /**
 214        Returns the tool tip of the field.
 215
 216        @return the tool tip of the field
 217      */
 218     const String & GetToolTip() const;
 219
 220     /**
 221        Sets the selected item.
 222
 223        If rItem is found in this dropdown field it is selected. If
 224        rItem is not found the selection will be empty.
 225
 226        @param rItem the item to be set
 227
 228        @retval TRUE the selected item was successfully set
 229        @retval TRUE failure (empty selection)
 230     */
 231     BOOL SetSelectedItem(const String & rItem);
 232
 233     /**
 234        Sets the name of the field.
 235
 236        @param rName the new name of the field
 237     */
 238     void SetName(const String & rName);
 239
 240     /**
 241        Sets the help text of the field.
 242
 243        @param rHelp    the help text
 244     */
 245     void SetHelp(const String & rHelp);
 246
 247     /**
 248        Sets the tool tip of the field.
 249
 250        @param rToolTip  the tool tip
 251     */
 252     void SetToolTip(const String & rToolTip);
 253
 254     /**
 255        API: Gets a property value from the dropdown field.
 256
 257        @param rVal return value
 258        @param nMId
 259           - FIELD_PROP_PAR1 Get selected item (String)
 260           - FIELD_PROP_STRINGS Get all items (Sequence)
 261           - FIELD_PROP_PAR3 Get the help text of the field.
 262           - FIELD_PROP_PAR4 Get the tool tip of the field.
 263     */
 264     virtual BOOL QueryValue(com::sun::star::uno::Any &rVal, USHORT nWhichId) const;
 265
 266     /**
 267        API: Sets a property value on the dropdown field.
 268
 269        @param rVal value to set
 270        @param nMId
 271           - FIELD_PROP_PAR1 Set selected item (String)
 272           - FIELD_PROP_STRINGS Set all items (Sequence)
 273           - FIELD_PROP_PAR3  Set the help text of the field.
 274           - FIELD_PROP_PAR4  Set the tool tip of the field.
 275     */
 276         virtual BOOL PutValue(const com::sun::star::uno::Any &rVal, USHORT nWhichId);
 277 };
 278
 279 #endif