277 lines
6.5 KiB
C++
277 lines
6.5 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2000, 2010 Oracle and/or its affiliates.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
#ifndef SW_FLDDROPDOWN_HXX
|
|
#define SW_FLDDROPDOWN_HXX
|
|
|
|
#include "com/sun/star/uno/Sequence.hxx"
|
|
#include "swdllapi.h"
|
|
#include "fldbas.hxx"
|
|
|
|
#include <vector>
|
|
|
|
/**
|
|
Field type for dropdown boxes.
|
|
*/
|
|
class SwDropDownFieldType : public SwFieldType
|
|
{
|
|
public:
|
|
/**
|
|
Constructor
|
|
*/
|
|
SwDropDownFieldType();
|
|
|
|
/**
|
|
Destructor
|
|
*/
|
|
virtual ~SwDropDownFieldType();
|
|
|
|
/**
|
|
Create a copy of this field type.
|
|
|
|
@return a copy of this type
|
|
*/
|
|
virtual SwFieldType * Copy () const;
|
|
};
|
|
|
|
/**
|
|
Dropdown field.
|
|
|
|
The dropdown field contains a list of strings. At most one of them
|
|
can be selected.
|
|
*/
|
|
class SW_DLLPUBLIC SwDropDownField : public SwField
|
|
{
|
|
/**
|
|
the possible values (aka items) of the dropdown box
|
|
*/
|
|
std::vector<rtl::OUString> aValues;
|
|
|
|
/**
|
|
the selected item
|
|
*/
|
|
rtl::OUString aSelectedItem;
|
|
|
|
/**
|
|
the name of the field
|
|
*/
|
|
rtl::OUString aName;
|
|
|
|
/**
|
|
help text
|
|
*/
|
|
rtl::OUString aHelp;
|
|
|
|
/**
|
|
tool tip string
|
|
*/
|
|
rtl::OUString aToolTip;
|
|
|
|
/**
|
|
Expands the field.
|
|
|
|
The expanded value of the field is the value of the selected
|
|
item. If no item is selected, an empty string is returned.
|
|
|
|
@return the expanded value of the field
|
|
*/
|
|
virtual String Expand() const;
|
|
|
|
/**
|
|
Creates a copy of this field.
|
|
|
|
@return the copy of this field
|
|
*/
|
|
virtual SwField * Copy() const;
|
|
|
|
public:
|
|
/**
|
|
Constructor
|
|
|
|
@param pTyp field type for this field
|
|
*/
|
|
SwDropDownField(SwFieldType * pTyp);
|
|
|
|
/**
|
|
Copy constructor
|
|
|
|
@param rSrc dropdown field to copy
|
|
*/
|
|
SwDropDownField(const SwDropDownField & rSrc);
|
|
|
|
/**
|
|
Destructor
|
|
*/
|
|
virtual ~SwDropDownField();
|
|
|
|
/**
|
|
Returns the selected value.
|
|
|
|
@see Expand
|
|
|
|
@return the selected value
|
|
*/
|
|
virtual const rtl::OUString & GetPar1() const;
|
|
|
|
/**
|
|
Returns the name of the field.
|
|
|
|
@return the name of the field
|
|
*/
|
|
virtual rtl::OUString GetPar2() const;
|
|
|
|
/**
|
|
Sets the selected value.
|
|
|
|
If rStr is an item of the field that item will be
|
|
selected. Otherwise no item will be selected, i.e. the
|
|
resulting selection will be empty.
|
|
*/
|
|
virtual void SetPar1(const rtl::OUString & rStr);
|
|
|
|
/**
|
|
Sets the name of the field.
|
|
|
|
@param rStr the new name of the field
|
|
*/
|
|
virtual void SetPar2(const rtl::OUString & rStr);
|
|
|
|
/**
|
|
Sets the items of the dropdown box.
|
|
|
|
After setting the items the selection will be empty.
|
|
|
|
@param rItems the new items
|
|
*/
|
|
void SetItems(const std::vector<rtl::OUString> & rItems);
|
|
|
|
/**
|
|
Sets the items of the dropdown box.
|
|
|
|
After setting the items the selection will be empty.
|
|
|
|
@param rItems the new items
|
|
*/
|
|
void SetItems(const com::sun::star::uno::Sequence<rtl::OUString> & rItems);
|
|
|
|
/**
|
|
Returns the items of the dropdown box.
|
|
|
|
@return the items of the dropdown box
|
|
*/
|
|
com::sun::star::uno::Sequence<rtl::OUString> GetItemSequence() const;
|
|
|
|
/**
|
|
Returns the selected item.
|
|
|
|
@return the selected item
|
|
*/
|
|
const rtl::OUString & GetSelectedItem() const;
|
|
|
|
/**
|
|
Returns the name of the field.
|
|
|
|
@return the name of the field
|
|
*/
|
|
const rtl::OUString & GetName() const;
|
|
|
|
/**
|
|
Returns the help text of the field.
|
|
|
|
@return the help text of the field
|
|
*/
|
|
const rtl::OUString & GetHelp() const;
|
|
|
|
/**
|
|
Returns the tool tip of the field.
|
|
|
|
@return the tool tip of the field
|
|
*/
|
|
const rtl::OUString & GetToolTip() const;
|
|
|
|
/**
|
|
Sets the selected item.
|
|
|
|
If rItem is found in this dropdown field it is selected. If
|
|
rItem is not found the selection will be empty.
|
|
|
|
@param rItem the item to be set
|
|
|
|
@retval sal_True the selected item was successfully set
|
|
@retval sal_True failure (empty selection)
|
|
*/
|
|
sal_Bool SetSelectedItem(const rtl::OUString & rItem);
|
|
|
|
/**
|
|
Sets the name of the field.
|
|
|
|
@param rName the new name of the field
|
|
*/
|
|
void SetName(const rtl::OUString & rName);
|
|
|
|
/**
|
|
Sets the help text of the field.
|
|
|
|
@param rHelp the help text
|
|
*/
|
|
void SetHelp(const rtl::OUString & rHelp);
|
|
|
|
/**
|
|
Sets the tool tip of the field.
|
|
|
|
@param rToolTip the tool tip
|
|
*/
|
|
void SetToolTip(const rtl::OUString & rToolTip);
|
|
|
|
/**
|
|
API: Gets a property value from the dropdown field.
|
|
|
|
@param rVal return value
|
|
@param nMId
|
|
- FIELD_PROP_PAR1 Get selected item (String)
|
|
- FIELD_PROP_STRINGS Get all items (Sequence)
|
|
- FIELD_PROP_PAR3 Get the help text of the field.
|
|
- FIELD_PROP_PAR4 Get the tool tip of the field.
|
|
*/
|
|
virtual bool QueryValue(com::sun::star::uno::Any &rVal, sal_uInt16 nWhichId) const;
|
|
|
|
/**
|
|
API: Sets a property value on the dropdown field.
|
|
|
|
@param rVal value to set
|
|
@param nMId
|
|
- FIELD_PROP_PAR1 Set selected item (String)
|
|
- FIELD_PROP_STRINGS Set all items (Sequence)
|
|
- FIELD_PROP_PAR3 Set the help text of the field.
|
|
- FIELD_PROP_PAR4 Set the tool tip of the field.
|
|
*/
|
|
virtual bool PutValue(const com::sun::star::uno::Any &rVal, sal_uInt16 nWhichId);
|
|
};
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|