kdelibs/kdeui/sonnet/dictionarycombobox.h
2014-11-13 01:04:59 +02:00

102 lines
2.8 KiB
C++

/*
* Copyright (c) 2003 Ingo Kloecker <kloecker@kde.org>
* Copyright (c) 2008 Tom Albers <tomalbers@kde.nl>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef SONNET_DICTIONARYCOMBOBOX_H
#define SONNET_DICTIONARYCOMBOBOX_H
#include "kdeui_export.h"
#include <kcombobox.h>
namespace Sonnet
{
/**
* @short A combo box for selecting the dictionary used for spell checking.
* @author Ingo Kloecker <kloecker@kde.org>
* @author Tom Albers <tomalbers@kde.nl>
* @since 4.2
**/
class KDEUI_EXPORT DictionaryComboBox : public KComboBox
{
Q_OBJECT
public:
/**
* Constructor
*/
explicit DictionaryComboBox( QWidget * parent=0 );
/**
* Destructor
*/
~DictionaryComboBox();
/**
* Clears the widget and reloads the dictionaries from Sonnet.
* Remember to set the dictionary you want selected after calling this function.
*/
void reloadCombo();
/**
* Returns the current dictionary name, for example "German (Switzerland)"
*/
QString currentDictionaryName() const;
/**
* Returns the current dictionary, for example "de_CH"
*/
QString currentDictionary() const;
/**
* Sets the current dictionaryName to the given dictionaryName
*/
void setCurrentByDictionaryName( const QString & dictionaryName );
/**
* Sets the current dictionary to the given dictionary.
*/
void setCurrentByDictionary( const QString & dictionary );
Q_SIGNALS:
/**
* @em Emitted whenever the current dictionary changes. Either
* by user intervention or on setCurrentByDictionaryName() or on
* setCurrentByDictionary(). For example "de_CH".
*/
void dictionaryChanged( const QString & dictionary );
/**
* @em Emitted whenever the current dictionary changes. Either
* by user intervention or on setCurrentByDictionaryName() or on
* setCurrentByDictionary(). For example "German (Switzerland)".
*/
void dictionaryNameChanged( const QString & dictionaryName );
private:
class Private;
Private* const d;
Q_PRIVATE_SLOT(d, void slotDictionaryChanged( int ) )
};
}
#endif