TextPropertyConfigModel Class Reference

#include <TextPropertyConfigModel.h>

Inheritance diagram for TextPropertyConfigModel:

Classes
struct	Private
struct	TextPropertyData

Public Types
enum	PropertyType { Character , Paragraph , Mixed }
enum	Roles { Visibility = Qt::UserRole + 1 , SearchTerms , Type , Name }
enum	VisibilityState {   FollowDefault = 0 , WhenRelevant = 1 , WhenSet = 2 , AlwaysVisible = 3 ,   NeverVisible = 4 }

Signals
void	defaultVisibilityStateChanged ()
void	shouldFilterChanged ()

Public Member Functions
Q_INVOKABLE void	addProperty (const QString &name, const int propertyType=0, const QString title=QString(), const QString toolTip=QString(), const QString searchTerms=QString(), const int visibilityState=-1)
QVariant	data (const QModelIndex &index, int role) const override
VisibilityState	defaultVisibilityState () const
Q_INVOKABLE void	loadFromConfiguration ()
bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild) override
QHash< int, QByteArray >	roleNames () const override
int	rowCount (const QModelIndex &parent) const override
void	saveConfiguration ()
bool	setData (const QModelIndex &index, const QVariant &value, int role) override
void	setDefaultVisibilityState (const VisibilityState state)
bool	shouldFilter () const
	TextPropertyConfigModel (QObject *parent=nullptr)
Q_INVOKABLE int	visibilityStateForName (const QString &name) const
	~TextPropertyConfigModel ()

Properties
VisibilityState	defaultVisibilityState
bool	shouldFilter

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

Definition at line 15 of file TextPropertyConfigModel.h.

Member Enumeration Documentation

PropertyType

enum TextPropertyConfigModel::PropertyType

Enumerator
Character	This property can be applied on a character level.
Paragraph	This property only does something when applied to a paragraph.
Mixed	This property can be in either.

Definition at line 31 of file TextPropertyConfigModel.h.

                      {
        Character, 
        Paragraph, 
        Mixed 
    };

Roles

enum TextPropertyConfigModel::Roles

Enumerator
Visibility
SearchTerms
Type
Name

Definition at line 38 of file TextPropertyConfigModel.h.

               {
        Visibility = Qt::UserRole + 1,
        SearchTerms,
        Type,
        Name,
    };

VisibilityState

enum TextPropertyConfigModel::VisibilityState

Enumerator
FollowDefault	Follow the default property.
WhenRelevant	Show when either set or inherited.
WhenSet	Show only when set.
AlwaysVisible	Always show property.
NeverVisible	Never show property.

Definition at line 22 of file TextPropertyConfigModel.h.

                         {
        FollowDefault = 0, 
        WhenRelevant = 1, 
        WhenSet = 2, 
        AlwaysVisible = 3, 
        NeverVisible = 4, 
    };

Constructor & Destructor Documentation

TextPropertyConfigModel()

TextPropertyConfigModel::TextPropertyConfigModel ( QObject * parent = nullptr )

explicit

Definition at line 35 of file TextPropertyConfigModel.cpp.

    : QAbstractListModel{parent}
    , d(new Private)
{
}

~TextPropertyConfigModel()

TextPropertyConfigModel::~TextPropertyConfigModel

(

)

Definition at line 41 of file TextPropertyConfigModel.cpp.

{
}

Member Function Documentation

addProperty()

void TextPropertyConfigModel::addProperty	(	const QString &	name,
		const int	propertyType = 0,
		const QString	title = QString(),
		const QString	toolTip = QString(),
		const QString	searchTerms = QString(),
		const int	visibilityState = -1 )

Definition at line 160 of file TextPropertyConfigModel.cpp.

{
    if (d->propertyNames.contains(name)) return;
    beginInsertRows(QModelIndex(), d->propertyNames.size(), d->propertyNames.size());
    TextPropertyData data = d->propertyData.value(name, TextPropertyData());
 
    data.title = title;
    data.propertyType = PropertyType(propertyType);
    data.toolTip = toolTip;
    data.searchTerms = searchTerms.split(",");
    data.visibilityState = VisibilityState(qMax(visibilityState, 0));
 
    d->propertyData.insert(name, data);
    d->propertyNames.append(name);
    endInsertRows();
}

References d, and data().

data()

QVariant TextPropertyConfigModel::data ( const QModelIndex & index, int role ) const

override

Definition at line 78 of file TextPropertyConfigModel.cpp.

{
    if (!index.isValid()) return QVariant();
    if (index.row() < 0 || index.row() >= d->propertyNames.size()) return QVariant();
 
    const QString name = d->propertyNames.at(index.row());
 
    const TextPropertyData data = d->propertyData.value(name);
    if (role == Name) {
        return name;
    } else if (role == Qt::DisplayRole) {
        return data.title;
    } else if (role == Qt::ToolTipRole) {
        return data.toolTip;
    } else if (role == Visibility) {
        return data.visibilityState;
    } else if (role == SearchTerms) {
        return data.searchTerms;
    } else if (role == Type) {
        return int (data.propertyType);
    }
    return QVariant();
}

References d, data(), Name, SearchTerms, Type, and Visibility.

defaultVisibilityState()

TextPropertyConfigModel::VisibilityState TextPropertyConfigModel::defaultVisibilityState

(

)

const

Definition at line 45 of file TextPropertyConfigModel.cpp.

                                                                                             {
    return d->defaultVisibilityState;
}

References d.

defaultVisibilityStateChanged

void TextPropertyConfigModel::defaultVisibilityStateChanged ( )

signal

loadFromConfiguration()

void TextPropertyConfigModel::loadFromConfiguration

(

)

Definition at line 152 of file TextPropertyConfigModel.cpp.

                                                    {
    KConfigGroup configGroup = KSharedConfig::openConfig()->group("TextProperties");
    d->defaultVisibilityState = visibilityConfigNames.key(configGroup.readEntry(DEFAULT_VISIBILITY_STATE, visibilityConfigNames.value(d->defaultVisibilityState)));
    Q_FOREACH (const QString name, d->propertyNames) {
        d->propertyData[name].visibilityState = visibilityConfigNames.key(configGroup.readEntry(name, visibilityConfigNames.value(d->propertyData[name].visibilityState)));
    }
}

References d, DEFAULT_VISIBILITY_STATE, and visibilityConfigNames.

moveRows()

bool TextPropertyConfigModel::moveRows ( const QModelIndex & sourceParent, int sourceRow, int count, const QModelIndex & destinationParent, int destinationChild )

override

Definition at line 120 of file TextPropertyConfigModel.cpp.

{
    if (sourceParent != destinationParent) return false;
    beginMoveRows(sourceParent, sourceRow, sourceRow+count, destinationParent, destinationChild);
    for (int i = 0; i < count; i++) {
        d->propertyNames.move(sourceRow+i, destinationChild+i);
    }
    endMoveRows();
    return true;
}

References d.

roleNames()

QHash< int, QByteArray > TextPropertyConfigModel::roleNames ( ) const

override

Definition at line 131 of file TextPropertyConfigModel.cpp.

{
    QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
    roles[Visibility] = "visibility";
    roles[SearchTerms] = "searchTerms";
    roles[Type] = "type";
    roles[Name] = "name";
    roles[Qt::DisplayRole] = "title";
    return roles;
}

References Name, SearchTerms, Type, and Visibility.

rowCount()

int TextPropertyConfigModel::rowCount ( const QModelIndex & parent ) const

override

Definition at line 72 of file TextPropertyConfigModel.cpp.

{
    Q_UNUSED(parent)
    return d->propertyNames.size();
}

References d.

saveConfiguration()

void TextPropertyConfigModel::saveConfiguration

(

)

Definition at line 142 of file TextPropertyConfigModel.cpp.

{
    KConfigGroup configGroup = KSharedConfig::openConfig()->group("TextProperties");
    configGroup.writeEntry(DEFAULT_VISIBILITY_STATE, visibilityConfigNames.value(d->defaultVisibilityState));
    Q_FOREACH (const QString name, d->propertyNames) {
        const TextPropertyData data = d->propertyData.value(name);
        configGroup.writeEntry(name, visibilityConfigNames.value(data.visibilityState));
    }
}

References d, data(), DEFAULT_VISIBILITY_STATE, and visibilityConfigNames.

setData()

bool TextPropertyConfigModel::setData ( const QModelIndex & index, const QVariant & value, int role )

override

Definition at line 102 of file TextPropertyConfigModel.cpp.

{
    if (!index.isValid() || !value.isValid()) return false;
    if (index.row() < 0 || index.row() >= d->propertyNames.size()) return false;
 
    if (role == Visibility) {
        VisibilityState newState = VisibilityState(value.toInt());
        const QString name = d->propertyNames.at(index.row());
        if (d->propertyData[name].visibilityState != newState) {
            d->propertyData[name].visibilityState = VisibilityState(value.toInt());
            emit dataChanged(index, index, {role});
            emit shouldFilterChanged();
            return true;
        }
    }
    return false;
}

References d, shouldFilterChanged(), value(), and Visibility.

setDefaultVisibilityState()

void TextPropertyConfigModel::setDefaultVisibilityState

(

const VisibilityState

state

)

Definition at line 49 of file TextPropertyConfigModel.cpp.

                                                                                   {
    if (state == d->defaultVisibilityState)
        return;
    d->defaultVisibilityState = state;
    emit defaultVisibilityStateChanged();
    emit shouldFilterChanged();
}

References d, defaultVisibilityStateChanged(), and shouldFilterChanged().

shouldFilter()

bool TextPropertyConfigModel::shouldFilter

(

)

const

Definition at line 57 of file TextPropertyConfigModel.cpp.

{
    bool shouldFilter = d->defaultVisibilityState == AlwaysVisible;
    if (!shouldFilter) return false;
 
    for (int i = 0; i < d->propertyData.size(); i++) {
        VisibilityState state = d->propertyData.values().at(i).visibilityState;
        if (state == WhenRelevant || state == WhenSet) {
            return false;
            break;
        }
    }
    return shouldFilter;
}

References AlwaysVisible, d, shouldFilter, WhenRelevant, and WhenSet.

shouldFilterChanged

void TextPropertyConfigModel::shouldFilterChanged ( )

signal

visibilityStateForName()

int TextPropertyConfigModel::visibilityStateForName

(

const QString &

name

)

const

Definition at line 177 of file TextPropertyConfigModel.cpp.

{
    TextPropertyData data = d->propertyData.value(name, TextPropertyData());
    return int(data.visibilityState);
}

References d, and data().

Member Data Documentation

d

const QScopedPointer<Private> TextPropertyConfigModel::d

private

Definition at line 81 of file TextPropertyConfigModel.h.

Property Documentation

defaultVisibilityState

VisibilityState TextPropertyConfigModel::defaultVisibilityState

readwrite

Definition at line 18 of file TextPropertyConfigModel.h.

shouldFilter

bool TextPropertyConfigModel::shouldFilter

read

Definition at line 19 of file TextPropertyConfigModel.h.

---

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

• plugins/dockers/textproperties/TextPropertyConfigModel.h
• plugins/dockers/textproperties/TextPropertyConfigModel.cpp