binfilter/inc/bf_sw/flddropdown.hxx

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