sw/inc/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.8 $
  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 #ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX
  34 #include "com/sun/star/uno/Sequence.hxx"
  35 #endif
  36 #include "swdllapi.h"
  37 #include "fldbas.hxx"
  38
  39 #ifndef INCLUDED_VECTOR
  40 #include <vector>
  41 #define INCLUDED_VECTOR
  42 #endif
  43
  44 /**
  45     Field type for dropdown boxes.
  46 */
  47 class SwDropDownFieldType : public SwFieldType
  48 {
  49 public:
  50     /**
  51        Constructor
  52     */
  53     SwDropDownFieldType();
  54
  55     /**
  56        Destructor
  57     */
  58     virtual ~SwDropDownFieldType();
  59
  60     /**
  61        Create a copy of this field type.
  62
  63        @return a copy of this type
  64     */
  65     virtual SwFieldType * Copy () const;
  66 };
  67
  68 /**
  69    Dropdown field.
  70
  71    The dropdown field contains a list of strings. At most one of them
  72    can be selected.
  73 */
  74 class SW_DLLPUBLIC SwDropDownField : public SwField
  75 {
  76     /**
  77        the possible values (aka items) of the dropdown box
  78     */
  79     std::vector<String> aValues;
  80
  81     /**
  82       the selected item
  83     */
  84     String aSelectedItem;
  85
  86     /**
  87       the name of the field
  88     */
  89     String aName;
  90
  91     /**
  92        help text
  93      */
  94     String aHelp;
  95
  96     /**
  97        tool tip string
  98      */
  99     String aToolTip;
 100
 101 public:
 102     /**
 103        Constructor
 104
 105        @param pTyp field type for this field
 106     */
 107     SwDropDownField(SwFieldType * pTyp);
 108
 109     /**
 110        Copy constructor
 111
 112        @param rSrc dropdown field to copy
 113     */
 114     SwDropDownField(const SwDropDownField & rSrc);
 115
 116     /**
 117        Destructor
 118     */
 119     virtual ~SwDropDownField();
 120
 121     /**
 122        Expands the field.
 123
 124        The expanded value of the field is the value of the selected
 125        item. If no item is selected, an empty string is returned.
 126
 127        @return the expanded value of the field
 128     */
 129     virtual String Expand() const;
 130
 131     /**
 132        Creates a copy of this field.
 133
 134        @return the copy of this field
 135     */
 136     virtual SwField * Copy() const;
 137
 138     /**
 139        Returns the selected value.
 140
 141        @see Expand
 142
 143        @return the selected value
 144     */
 145     virtual const String & GetPar1() const;
 146
 147     /**
 148        Returns the name of the field.
 149
 150        @return the name of the field
 151     */
 152     virtual String GetPar2() const;
 153
 154     /**
 155        Sets the selected value.
 156
 157        If rStr is an item of the field that item will be
 158        selected. Otherwise no item will be selected, i.e. the
 159        resulting selection will be empty.
 160     */
 161     virtual void SetPar1(const String & rStr);
 162
 163     /**
 164        Sets the name of the field.
 165
 166        @param rStr the new name of the field
 167     */
 168     virtual void SetPar2(const String & rStr);
 169
 170     /**
 171        Sets the items of the dropdown box.
 172
 173        After setting the items the selection will be empty.
 174
 175        @param rItems the new items
 176     */
 177     void SetItems(const std::vector<String> & rItems);
 178
 179     /**
 180        Sets the items of the dropdown box.
 181
 182        After setting the items the selection will be empty.
 183
 184        @param rItems the new items
 185     */
 186     void SetItems(const com::sun::star::uno::Sequence<rtl::OUString> & rItems);
 187
 188     /**
 189         Returns the items of the dropdown box.
 190
 191         @return the items of the dropdown box
 192     */
 193     com::sun::star::uno::Sequence<rtl::OUString> GetItemSequence() const;
 194
 195     /**
 196        Returns the selected item.
 197
 198        @return the selected item
 199     */
 200     const String & GetSelectedItem() const;
 201
 202     /**
 203        Returns the name of the field.
 204
 205        @return the name of the field
 206     */
 207     const String & GetName() const;
 208
 209     /**
 210        Returns the help text of the field.
 211
 212        @return the help text of the field
 213     */
 214     const String & GetHelp() const;
 215
 216     /**
 217        Returns the tool tip of the field.
 218
 219        @return the tool tip of the field
 220      */
 221     const String & GetToolTip() const;
 222
 223     /**
 224        Sets the selected item.
 225
 226        If rItem is found in this dropdown field it is selected. If
 227        rItem is not found the selection will be empty.
 228
 229        @param rItem the item to be set
 230
 231        @retval TRUE the selected item was successfully set
 232        @retval TRUE failure (empty selection)
 233     */
 234     BOOL SetSelectedItem(const String & rItem);
 235
 236     /**
 237        Sets the name of the field.
 238
 239        @param rName the new name of the field
 240     */
 241     void SetName(const String & rName);
 242
 243     /**
 244        Sets the help text of the field.
 245
 246        @param rHelp    the help text
 247     */
 248     void SetHelp(const String & rHelp);
 249
 250     /**
 251        Sets the tool tip of the field.
 252
 253        @param rToolTip  the tool tip
 254     */
 255     void SetToolTip(const String & rToolTip);
 256
 257     /**
 258        API: Gets a property value from the dropdown field.
 259
 260        @param rVal return value
 261        @param nMId
 262           - FIELD_PROP_PAR1 Get selected item (String)
 263           - FIELD_PROP_STRINGS Get all items (Sequence)
 264           - FIELD_PROP_PAR3 Get the help text of the field.
 265           - FIELD_PROP_PAR4 Get the tool tip of the field.
 266     */
 267     virtual BOOL QueryValue(com::sun::star::uno::Any &rVal, USHORT nWhichId) const;
 268
 269     /**
 270        API: Sets a property value on the dropdown field.
 271
 272        @param rVal value to set
 273        @param nMId
 274           - FIELD_PROP_PAR1 Set selected item (String)
 275           - FIELD_PROP_STRINGS Set all items (Sequence)
 276           - FIELD_PROP_PAR3  Set the help text of the field.
 277           - FIELD_PROP_PAR4  Set the tool tip of the field.
 278     */
 279         virtual BOOL PutValue(const com::sun::star::uno::Any &rVal, USHORT nWhichId);
 280 };
 281
 282 #endif