KLanguageButton Class Reference

#include <klanguagebutton.h>

Inheritance diagram for KLanguageButton:

Signals
void	activated (const QString &languageCode)
void	highlighted (const QString &languageCode)

Public Member Functions
void	clear ()
bool	contains (const QString &languageCode) const
int	count () const
QString	current () const
void	insertLanguage (const QString &languageCode, const QString &name=QString(), int index=-1)
void	insertSeparator (int index=-1)
	KLanguageButton (const QString &text, QWidget *parent=0)
	KLanguageButton (QWidget *parent=0)
void	loadAllLanguages ()
void	setCurrentItem (const QString &languageCode)
void	setLocale (const QString &locale)
void	setText (const QString &text)
void	showLanguageCodes (bool show)
	~KLanguageButton () override

Private Slots
void	slotHovered (QAction *)
void	slotTriggered (QAction *)

Private Attributes
KLanguageButtonPrivate *const	d

Detailed Description

KLanguageButton is a pushbutton which allows a language to be selected from a popup list.

Languages are identified by their ISO 639-1 codes, e.g. en, pt_BR.

KDE Language Selection Widget

Author

Hans Petter Bieker bieke.nosp@m.r@kd.nosp@m.e.org, Martijn Klingens kling.nosp@m.ens@.nosp@m.kde.o.nosp@m.rg, David Jarvie softw.nosp@m.are@.nosp@m.astro.nosp@m.jar..nosp@m.org.u.nosp@m.k

Definition at line 32 of file klanguagebutton.h.

Constructor & Destructor Documentation

KLanguageButton() [1/2]

KLanguageButton::KLanguageButton ( QWidget * parent = 0 )

explicit

Constructs a button whose text is determined by the current language in the popup list.

Parameters

parent

the parent of the button

Definition at line 69 of file klanguagebutton.cpp.

    : QWidget(parent),
      d(new KLanguageButtonPrivate(this))
{
}

KLanguageButton() [2/2]

KLanguageButton::KLanguageButton ( const QString & text, QWidget * parent = 0 )

explicit

Constructs a button with static text.

Parameters

text	the text of the button
parent	the parent of the button

Definition at line 75 of file klanguagebutton.cpp.

    : QWidget(parent),
      d(new KLanguageButtonPrivate(this))
{
    setText(text);
}

References setText().

~KLanguageButton()

KLanguageButton::~KLanguageButton ( )

override

Deconstructor

Definition at line 102 of file klanguagebutton.cpp.

{
    delete d;
}

References d.

Member Function Documentation

activated

void KLanguageButton::activated ( const QString & languageCode )

signal

This signal is emitted when a new item is activated.

Parameters

languageCode

code of the activated language

clear()

void KLanguageButton::clear

(

)

Removes all combobox items.

Definition at line 213 of file klanguagebutton.cpp.

{
    d->clear();
}

References KLanguageButtonPrivate::clear(), and d.

contains()

bool KLanguageButton::contains

(

const QString &

languageCode

)

const

Checks whether the specified language is in the popup list.

Parameters

languageCode

the language's code

Returns

true if in the list

Definition at line 228 of file klanguagebutton.cpp.

{
    return d->ids.contains(languageCode);
}

References d, and KLanguageButtonPrivate::ids.

count()

int KLanguageButton::count

(

)

const

Returns the number of items in the combo box.

Definition at line 208 of file klanguagebutton.cpp.

{
    return d->ids.count();
}

References d, and KLanguageButtonPrivate::ids.

current()

QString KLanguageButton::current

(

)

const

Returns the language code of the combobox's current item.

Returns

the current item's language code

Definition at line 233 of file klanguagebutton.cpp.

{
    return d->current.isEmpty() ? QLatin1String("en") : d->current;
}

References KLanguageButtonPrivate::current, and d.

highlighted

void KLanguageButton::highlighted ( const QString & languageCode )

signal

This signal is emitted when a new item is highlighted.

Parameters

languageCode

code of the highlighted language

insertLanguage()

void KLanguageButton::insertLanguage	(	const QString &	languageCode,
		const QString &	name = QString(),
		int	index = -1 )

Inserts a language into the combo box. Normally the display name of the language is obtained automatically, but if either the language code does not exist, or there are special display requirements, the name of the language can be specified in name.

Parameters

languageCode	the code for the language
name	language name. If empty, the name is obtained automatically.
index	the insertion position, or -1 to insert in alphabetical order

Definition at line 123 of file klanguagebutton.cpp.

{
    QString text;
    bool showCodes = d->showCodes;
    if (name.isEmpty()) {
        text = languageCode;
        QLocale locale(languageCode);
        if (locale != QLocale::c()) {
            text = locale.nativeLanguageName();
        } else {
            showCodes = false;
        }
    } else {
        text = name;
    }
    if (showCodes) {
        text += QLatin1String(" (") + languageCode + QLatin1Char(')');
    }
 
    checkInsertPos(d->popup, text, index);
    QAction *a = new QAction(QIcon(), text, this);
    a->setData(languageCode);
    if (index >= 0 && index < d->popup->actions().count() - 1) {
        d->popup->insertAction(d->popup->actions()[index], a);
    } else {
        d->popup->addAction(a);
    }
    d->ids.append(languageCode);
}

References checkInsertPos(), d, KLanguageButtonPrivate::ids, KLanguageButtonPrivate::popup, and KLanguageButtonPrivate::showCodes.

insertSeparator()

void KLanguageButton::insertSeparator

(

int

index = -1

)

Inserts a separator item into the combo box. A negative index will append the item.

Parameters

index

the insertion position

Definition at line 153 of file klanguagebutton.cpp.

{
    if (index >= 0 && index < d->popup->actions().count() - 1) {
        d->popup->insertSeparator(d->popup->actions()[index]);
    } else {
        d->popup->addSeparator();
    }
}

References d, and KLanguageButtonPrivate::popup.

loadAllLanguages()

void KLanguageButton::loadAllLanguages

(

)

Load all known languages into the popup list. The current language in the list is set to the default language for the current locale (as modified by setLocale()).

Definition at line 162 of file klanguagebutton.cpp.

{
    QStringList langlist;
    const QStringList localeDirs = QStandardPaths::locateAll(QStandardPaths::AppDataLocation, QString("locale"), QStandardPaths::LocateDirectory);
    Q_FOREACH (const QString &localeDir, localeDirs) {
        const QStringList entries = QDir(localeDir).entryList(QDir::Dirs);
        Q_FOREACH (const QString &d, entries) {
            const QString entryFile = localeDir + '/' + d + "/kf5_entry.desktop";
            if (QFile::exists(entryFile)) {
                langlist.append(entryFile);
            }
        }
    }
    langlist.sort();
    for (int i = 0, count = langlist.count(); i < count; ++i) {
        QString fpath = langlist[i].left(langlist[i].length() - 14);
        QString code = fpath.mid(fpath.lastIndexOf('/') + 1);
        KConfig entry(langlist[i], KConfig::SimpleConfig);
        KConfigGroup group(&entry, "KCM Locale");
        QString name = group.readEntry("Name", i18n("without name"));
        insertLanguage(code, name);
    }
 
    setCurrentItem(d->locale);
}

References count(), d, insertLanguage(), length(), KLanguageButtonPrivate::locale, and setCurrentItem().

setCurrentItem()

void KLanguageButton::setCurrentItem

(

const QString &

languageCode

)

Sets a given language to be the current item.

Parameters

languageCode

the language's code

Definition at line 248 of file klanguagebutton.cpp.

{
    if (!d->ids.count()) {
        return;
    }
    QAction *a;
    if (d->ids.indexOf(languageCode) < 0) {
        a = d->findAction(d->ids[0]);
    } else {
        a = d->findAction(languageCode);
    }
    if (a) {
        d->setCurrentItem(a);
    }
}

References d, KLanguageButtonPrivate::findAction(), KLanguageButtonPrivate::ids, and KLanguageButtonPrivate::setCurrentItem().

setLocale()

void KLanguageButton::setLocale

(

const QString &

locale

)

Sets the locale to display language names. By default, QLocale::system().name() is used.

Parameters

locale

locale to use

Definition at line 113 of file klanguagebutton.cpp.

{
    d->locale = locale;
}

References d, and KLanguageButtonPrivate::locale.

setText()

void KLanguageButton::setText

(

const QString &

text

)

Sets a static button text.

Parameters

text	button text

Definition at line 107 of file klanguagebutton.cpp.

{
    d->staticText = true;
    d->button->setText(text);
}

References KLanguageButtonPrivate::button, d, and KLanguageButtonPrivate::staticText.

showLanguageCodes()

void KLanguageButton::showLanguageCodes

(

bool

show

)

Specifies whether language codes should be shown alongside language names in the popup. Calling this method does not affect any previously inserted language texts, so it should normally be called before populating the list.

Parameters

show	true to show codes, false to hide codes

Definition at line 118 of file klanguagebutton.cpp.

{
    d->showCodes = show;
}

References d, and KLanguageButtonPrivate::showCodes.

slotHovered

void KLanguageButton::slotHovered ( QAction * a )

privateslot

Definition at line 201 of file klanguagebutton.cpp.

{
    //qDebug() << "slotHovered" << index;
 
    Q_EMIT highlighted(a->data().toString());
}

References highlighted().

slotTriggered

void KLanguageButton::slotTriggered ( QAction * a )

privateslot

Definition at line 188 of file klanguagebutton.cpp.

{
    //qDebug() << "slotTriggered" << index;
    if (!a) {
        return;
    }
 
    d->setCurrentItem(a);
 
    // Forward event from popup menu as if it was emitted from this widget:
    Q_EMIT activated(d->current);
}

References activated(), KLanguageButtonPrivate::current, d, and KLanguageButtonPrivate::setCurrentItem().

Member Data Documentation

d

KLanguageButtonPrivate* const KLanguageButton::d

private

Definition at line 159 of file klanguagebutton.h.

---

The documentation for this class was generated from the following files:

• libs/widgetutils/config/klanguagebutton.h
• libs/widgetutils/config/klanguagebutton.cpp