IrcBufferModel Class Reference

#include <IrcBufferModel>

Inheritance diagram for IrcBufferModel:

Public Slots
void	clear ()
void	receiveMessage (IrcMessage *message)
void	sort (int column=0, Qt::SortOrder order=Qt::AscendingOrder)
void	sort (Irc::SortMethod method, Qt::SortOrder order=Qt::AscendingOrder)

Signals
void	countChanged (int count)
void	emptyChanged (bool empty)
void	added (IrcBuffer *buffer)
void	removed (IrcBuffer *buffer)
void	aboutToBeAdded (IrcBuffer *buffer)
void	aboutToBeRemoved (IrcBuffer *buffer)
void	persistentChanged (bool persistent)
void	buffersChanged (const QList< IrcBuffer *> &buffers)
void	channelsChanged (const QStringList &channels)
void	connectionChanged (IrcConnection *connection)
void	networkChanged (IrcNetwork *network)
void	messageIgnored (IrcMessage *message)
void	bufferPrototypeChanged (IrcBuffer *prototype)
void	channelPrototypeChanged (IrcChannel *prototype)
void	destroyed (IrcBufferModel *model)
void	joinDelayChanged (int delay)
void	monitorEnabledChanged (bool enabled)

Public Member Functions
	IrcBufferModel (QObject *parent=0)
virtual	~IrcBufferModel ()
IrcConnection *	connection () const
void	setConnection (IrcConnection *connection)
IrcNetwork *	network () const
int	count () const
bool	isEmpty () const
QStringList	channels () const
QList< IrcBuffer * >	buffers () const
Q_INVOKABLE IrcBuffer *	get (int index) const
Q_INVOKABLE IrcBuffer *	find (const QString &title) const
Q_INVOKABLE bool	contains (const QString &title) const
Q_INVOKABLE int	indexOf (IrcBuffer *buffer) const
Q_INVOKABLE IrcBuffer *	add (const QString &title)
Q_INVOKABLE void	add (IrcBuffer *buffer)
Q_INVOKABLE void	remove (const QString &title)
Q_INVOKABLE void	remove (IrcBuffer *buffer)
Qt::SortOrder	sortOrder () const
void	setSortOrder (Qt::SortOrder order)
Irc::SortMethod	sortMethod () const
void	setSortMethod (Irc::SortMethod method)
Irc::DataRole	displayRole () const
void	setDisplayRole (Irc::DataRole role)
bool	isPersistent () const
void	setPersistent (bool persistent)
QModelIndex	index (IrcBuffer *buffer) const
IrcBuffer *	buffer (const QModelIndex &index) const
QHash< int, QByteArray >	roleNames () const
int	rowCount (const QModelIndex &parent=QModelIndex()) const
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const
QModelIndex	index (int row, int column=0, const QModelIndex &parent=QModelIndex()) const
IrcBuffer *	bufferPrototype () const
void	setBufferPrototype (IrcBuffer *prototype)
IrcChannel *	channelPrototype () const
void	setChannelPrototype (IrcChannel *prototype)
int	joinDelay () const
void	setJoinDelay (int delay)
bool	isMonitorEnabled () const
void	setMonitorEnabled (bool enabled)
Q_INVOKABLE QByteArray	saveState (int version=0) const
Q_INVOKABLE bool	restoreState (const QByteArray &state, int version=0)

Protected Slots
virtual IrcBuffer *	createBuffer (const QString &title)
virtual IrcChannel *	createChannel (const QString &title)

Protected Member Functions
virtual bool	lessThan (IrcBuffer *one, IrcBuffer *another, Irc::SortMethod method) const

Properties
int	count
bool	empty
Qt::SortOrder	sortOrder
Irc::SortMethod	sortMethod
QStringList	channels
Irc::DataRole	displayRole
bool	persistent
QList< IrcBuffer * >	buffers
IrcConnection	connection
IrcNetwork	network
IrcBuffer	bufferPrototype
IrcChannel	channelPrototype
int	joinDelay
bool	monitorEnabled

Private Member Functions
	Q_PRIVATE_SLOT (d_func(), void _irc_connected()) Q_PRIVATE_SLOT(d_func()
void	_irc_initialized ()) Q_PRIVATE_SLOT(d_func()
void void	_irc_disconnected ()) Q_PRIVATE_SLOT(d_func()
void void void	_irc_bufferDestroyed (IrcBuffer *)) Q_PRIVATE_SLOT(d_func()
void void void void	_irc_restoreBuffers ()) Q_PRIVATE_SLOT(d_func()

Private Attributes
QScopedPointer< IrcBufferModelPrivate >	d_ptr

Friends
class	IrcBufferLessThan
class	IrcBufferGreaterThan

Detailed Description

IrcBufferModel automatically keeps track of channel and query buffers and manages IrcBuffer instances for them. It will notify via signals when channel and query buffers are added and/or removed. IrcBufferModel can be used directly as a data model for Qt's item views - both in C++ and QML.

IrcConnection* connection = new IrcConnection(this);
IrcBufferModel* model = new IrcBufferModel(connection);
connect(model, SIGNAL(added(IrcBuffer*)), this, SLOT(onBufferAdded(IrcBuffer*)));
connect(model, SIGNAL(removed(IrcBuffer*)), this, SLOT(onBufferRemoved(IrcBuffer*)));
listView->setModel(model);

Definition at line 47 of file ircbuffermodel.h.

Constructor & Destructor Documentation

IrcBufferModel()

IrcBufferModel::IrcBufferModel ( QObject *  parent = 0 )

explicit

Constructs a new model with parent.

Note

If parent is an instance of IrcConnection, it will be automatically assigned to connection.

Definition at line 580 of file ircbuffermodel.cpp.

References setBufferPrototype(), setChannelPrototype(), and setConnection().

    : QAbstractListModel(parent), d_ptr(new IrcBufferModelPrivate)
{
    Q_D(IrcBufferModel);
    d->q_ptr = this;
    setBufferPrototype(new IrcBuffer(this));
    setChannelPrototype(new IrcChannel(this));
    setConnection(qobject_cast<IrcConnection*>(parent));
}

Here is the call graph for this function:

~IrcBufferModel()

IrcBufferModel::~IrcBufferModel ( )

virtual

Destructs the model.

Definition at line 593 of file ircbuffermodel.cpp.

References buffer(), connection(), and destroyed().

{
    Q_D(IrcBufferModel);
    foreach (IrcBuffer* buffer, d->bufferList) {
        buffer->disconnect(this);
        delete buffer;
    }
    d->bufferList.clear();
    d->bufferMap.clear();
    d->channels.clear();
    emit destroyed(this);
}

Here is the call graph for this function:

Member Function Documentation

connection()

IrcConnection* IrcBufferModel::connection

(

)

const

Referenced by setConnection(), and ~IrcBufferModel().

Here is the caller graph for this function:

setConnection()

void IrcBufferModel::setConnection

(

IrcConnection *

connection

)

Definition at line 621 of file ircbuffermodel.cpp.

References _irc_disconnected(), _irc_initialized(), connection(), connectionChanged(), count(), IrcConnection::installMessageFilter(), network(), networkChanged(), and rowCount().

Referenced by IrcBufferModel().

{
    Q_D(IrcBufferModel);
    if (d->connection != connection) {
        if (d->connection) {
            qCritical("IrcBufferModel::setConnection(): changing the connection on the fly is not supported.");
            return;
        }
        d->connection = connection;
        d->connection->installMessageFilter(d);
        d->connection->installCommandFilter(d);
        connect(d->connection, SIGNAL(connected()), this, SLOT(_irc_connected()));
        connect(d->connection, SIGNAL(disconnected()), this, SLOT(_irc_disconnected()));
        connect(d->connection->network(), SIGNAL(initialized()), this, SLOT(_irc_initialized()));
        emit connectionChanged(connection);
        emit networkChanged(network());
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

network()

IrcNetwork* IrcBufferModel::network

(

)

const

Referenced by setConnection().

Here is the caller graph for this function:

count()

int IrcBufferModel::count

(

)

const

Referenced by setConnection().

Here is the caller graph for this function:

isEmpty()

bool IrcBufferModel::isEmpty

(

)

const

Definition at line 678 of file ircbuffermodel.cpp.

References buffers(), and channels().

{
    Q_D(const IrcBufferModel);
    return d->bufferList.isEmpty();
}

Here is the call graph for this function:

channels()

QStringList IrcBufferModel::channels

(

)

const

Referenced by isEmpty().

Here is the caller graph for this function:

buffers()

QList<IrcBuffer*> IrcBufferModel::buffers

(

)

const

Referenced by isEmpty(), restoreState(), and saveState().

Here is the caller graph for this function:

get()

IrcBuffer * IrcBufferModel::get

(

int

index

)

const

Returns the buffer object at index.

Definition at line 717 of file ircbuffermodel.cpp.

{
    Q_D(const IrcBufferModel);
    return d->bufferList.value(index);
}

find()

IrcBuffer * IrcBufferModel::find

(

const QString &

title

)

const

Returns the buffer object for title or 0 if not found.

Definition at line 726 of file ircbuffermodel.cpp.

Referenced by dlgIRC::processCustomCommand().

{
    Q_D(const IrcBufferModel);
    return d->bufferMap.value(title.toLower());
}

Here is the caller graph for this function:

contains()

bool IrcBufferModel::contains

(

const QString &

title

)

const

Returns true if the model contains title.

Definition at line 735 of file ircbuffermodel.cpp.

{
    Q_D(const IrcBufferModel);
    return d->bufferMap.contains(title.toLower());
}

indexOf()

int IrcBufferModel::indexOf

(

IrcBuffer *

buffer

)

const

Returns the index of the specified buffer, or -1 if the model does not contain the buffer.

Definition at line 745 of file ircbuffermodel.cpp.

{
    Q_D(const IrcBufferModel);
    return d->bufferList.indexOf(buffer);
}

add() [1/2]

IrcBuffer * IrcBufferModel::add

(

const QString &

title

)

Adds a buffer with title to the model and returns it.

Definition at line 754 of file ircbuffermodel.cpp.

Referenced by dlgIRC::setupBuffers(), and dlgIRC::slot_onUserActivated().

{
    Q_D(IrcBufferModel);
    return d->createBuffer(title);
}

Here is the caller graph for this function:

add() [2/2]

void IrcBufferModel::add

(

IrcBuffer *

buffer

)

Adds the buffer to the model.

Definition at line 763 of file ircbuffermodel.cpp.

{
    Q_D(IrcBufferModel);
    d->addBuffer(buffer);
}

remove() [1/2]

void IrcBufferModel::remove

(

const QString &

title

)

Removes and destroys a buffer with title from the model.

Definition at line 772 of file ircbuffermodel.cpp.

Referenced by dlgIRC::ircRestart().

{
    Q_D(IrcBufferModel);
    d->destroyBuffer(title, true);
}

Here is the caller graph for this function:

remove() [2/2]

void IrcBufferModel::remove

(

IrcBuffer *

buffer

)

Removes and destroys a buffer from the model.

Definition at line 781 of file ircbuffermodel.cpp.

References buffer(), and displayRole().

{
    delete buffer;
}

Here is the call graph for this function:

sortOrder()

Qt::SortOrder IrcBufferModel::sortOrder

(

)

const

Referenced by buffer().

Here is the caller graph for this function:

setSortOrder()

void IrcBufferModel::setSortOrder

(

Qt::SortOrder

order

)

Definition at line 881 of file ircbuffermodel.cpp.

References sort(), Irc::SortByHand, and sortMethod().

{
    Q_D(IrcBufferModel);
    if (d->sortOrder != order) {
        d->sortOrder = order;
        if (d->sortMethod != Irc::SortByHand && !d->bufferList.isEmpty())
            sort(d->sortMethod, d->sortOrder);
    }
}

Here is the call graph for this function:

sortMethod()

Irc::SortMethod IrcBufferModel::sortMethod

(

)

const

Referenced by setSortOrder().

Here is the caller graph for this function:

setSortMethod()

void IrcBufferModel::setSortMethod

(

Irc::SortMethod

method

)

Definition at line 917 of file ircbuffermodel.cpp.

References sort(), and Irc::SortByHand.

{
    Q_D(IrcBufferModel);
    if (d->sortMethod != method) {
        d->sortMethod = method;
        if (d->sortMethod != Irc::SortByHand && !d->bufferList.isEmpty())
            sort(d->sortMethod, d->sortOrder);
    }
}

Here is the call graph for this function:

displayRole()

Irc::DataRole IrcBufferModel::displayRole

(

)

const

Referenced by remove().

Here is the caller graph for this function:

setDisplayRole()

void IrcBufferModel::setDisplayRole

(

Irc::DataRole

role

)

Definition at line 803 of file ircbuffermodel.cpp.

{
    Q_D(IrcBufferModel);
    d->role = role;
}

isPersistent()

bool IrcBufferModel::isPersistent

(

)

const

Definition at line 829 of file ircbuffermodel.cpp.

{
    Q_D(const IrcBufferModel);
    return d->persistent;
}

setPersistent()

void IrcBufferModel::setPersistent

(

bool

persistent

)

Definition at line 835 of file ircbuffermodel.cpp.

References persistent, and persistentChanged().

{
    Q_D(IrcBufferModel);
    if (d->persistent != persistent) {
        d->persistent = persistent;
        emit persistentChanged(persistent);
    }
}

index() [1/2]

QModelIndex IrcBufferModel::index

(

IrcBuffer *

buffer

)

const

Returns the model index for buffer.

Definition at line 847 of file ircbuffermodel.cpp.

Referenced by dlgIRC::processCustomCommand(), dlgIRC::slot_onBufferAdded(), dlgIRC::slot_onUserActivated(), and sort().

{
    Q_D(const IrcBufferModel);
    return index(d->bufferList.indexOf(buffer));
}

Here is the caller graph for this function:

buffer()

IrcBuffer * IrcBufferModel::buffer

(

const QModelIndex &

index

)

const

Returns the buffer for model index.

Definition at line 856 of file ircbuffermodel.cpp.

References sortOrder().

Referenced by clear(), data(), remove(), saveState(), sort(), and ~IrcBufferModel().

{
    if (!hasIndex(index.row(), index.column()))
        return 0;

    return static_cast<IrcBuffer*>(index.internalPointer());
}

Here is the call graph for this function:

Here is the caller graph for this function:

roleNames()

QHash< int, QByteArray > IrcBufferModel::roleNames

(

)

const

The following role names are provided by default:

Role	Name	Type	Example
Qt::DisplayRole	"display"	1)	-
Irc::BufferRole	"buffer"	IrcBuffer*	<object>
Irc::ChannelRole	"channel"	IrcChannel*	<object>
Irc::NameRole	"name"	QString	"communi"
Irc::PrefixRole	"prefix"	QString	"#"
Irc::TitleRole	"title"	QString	"#communi"

1) The type depends on displayRole.

Definition at line 1112 of file ircbuffermodel.cpp.

References Irc::BufferRole, Irc::ChannelRole, Irc::NameRole, Irc::PrefixRole, and Irc::TitleRole.

{
    QHash<int, QByteArray> roles;
    roles[Qt::DisplayRole] = "display";
    roles[Irc::BufferRole] = "buffer";
    roles[Irc::ChannelRole] = "channel";
    roles[Irc::NameRole] = "name";
    roles[Irc::PrefixRole] = "prefix";
    roles[Irc::TitleRole] = "title";
    return roles;
}

rowCount()

int IrcBufferModel::rowCount

(

const QModelIndex &

parent = QModelIndex()

)

const

Returns the number of buffers.

Definition at line 1127 of file ircbuffermodel.cpp.

Referenced by setConnection().

{
    if (parent.isValid())
        return 0;

    Q_D(const IrcBufferModel);
    return d->bufferList.count();
}

Here is the caller graph for this function:

data()

QVariant IrcBufferModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole
	)		const

Returns the data for specified role and user referred to by by the index.

Definition at line 1139 of file ircbuffermodel.cpp.

References buffer(), Irc::BufferRole, Irc::ChannelRole, IrcBuffer::name, Irc::NameRole, IrcBuffer::prefix, Irc::PrefixRole, IrcBuffer::title, Irc::TitleRole, and IrcBuffer::toChannel().

{
    Q_D(const IrcBufferModel);
    if (!hasIndex(index.row(), index.column(), index.parent()))
        return QVariant();

    IrcBuffer* buffer = static_cast<IrcBuffer*>(index.internalPointer());
    Q_ASSERT(buffer);

    switch (role) {
    case Qt::DisplayRole:
        return data(index, d->role);
    case Irc::BufferRole:
        return QVariant::fromValue(buffer);
    case Irc::ChannelRole:
        return QVariant::fromValue(buffer->toChannel());
    case Irc::NameRole:
        return buffer->name();
    case Irc::PrefixRole:
        return buffer->prefix();
    case Irc::TitleRole:
        return buffer->title();
    }

    return QVariant();
}

Here is the call graph for this function:

index() [2/2]

QModelIndex IrcBufferModel::index	(	int	row,
		int	column = 0,
		const QModelIndex &	parent = QModelIndex()
	)		const

Returns the index of the item in the model specified by the given row, column and parent index.

Definition at line 1169 of file ircbuffermodel.cpp.

References bufferPrototype().

{
    Q_D(const IrcBufferModel);
    if (!hasIndex(row, column, parent))
        return QModelIndex();

    return createIndex(row, column, d->bufferList.at(row));
}

Here is the call graph for this function:

bufferPrototype()

IrcBuffer* IrcBufferModel::bufferPrototype

(

)

const

Referenced by index().

Here is the caller graph for this function:

setBufferPrototype()

void IrcBufferModel::setBufferPrototype

(

IrcBuffer *

prototype

)

Definition at line 1195 of file ircbuffermodel.cpp.

References bufferPrototypeChanged(), and channelPrototype().

Referenced by IrcBufferModel().

{
    Q_D(IrcBufferModel);
    if (d->bufferProto != prototype) {
        if (d->bufferProto && d->bufferProto->parent() == this)
            delete d->bufferProto;
        d->bufferProto = prototype ? prototype : new IrcBuffer(this);
        emit bufferPrototypeChanged(d->bufferProto);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

channelPrototype()

IrcChannel* IrcBufferModel::channelPrototype

(

)

const

Referenced by setBufferPrototype().

Here is the caller graph for this function:

setChannelPrototype()

void IrcBufferModel::setChannelPrototype

(

IrcChannel *

prototype

)

Definition at line 1223 of file ircbuffermodel.cpp.

References channelPrototypeChanged(), and joinDelay().

Referenced by IrcBufferModel().

{
    Q_D(IrcBufferModel);
    if (d->channelProto != prototype) {
        if (d->channelProto && d->channelProto->parent() == this)
            delete d->channelProto;
        d->channelProto = prototype ? prototype : new IrcChannel(this);
        emit channelPrototypeChanged(d->channelProto);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

joinDelay()

int IrcBufferModel::joinDelay

(

)

const

Referenced by setChannelPrototype().

Here is the caller graph for this function:

setJoinDelay()

void IrcBufferModel::setJoinDelay

(

int

delay

)

Definition at line 1256 of file ircbuffermodel.cpp.

References joinDelayChanged().

{
    Q_D(IrcBufferModel);
    if (d->joinDelay != delay) {
        d->joinDelay = delay;
        emit joinDelayChanged(delay);
    }
}

isMonitorEnabled()

bool IrcBufferModel::isMonitorEnabled

(

)

const

Definition at line 1282 of file ircbuffermodel.cpp.

{
    Q_D(const IrcBufferModel);
    return d->monitorEnabled;
}

setMonitorEnabled()

void IrcBufferModel::setMonitorEnabled

(

bool

enabled

)

Definition at line 1288 of file ircbuffermodel.cpp.

References monitorEnabledChanged().

{
    Q_D(IrcBufferModel);
    if (d->monitorEnabled != enabled) {
        d->monitorEnabled = enabled;
        emit monitorEnabledChanged(enabled);
    }
}

saveState()

QByteArray IrcBufferModel::saveState

(

int

version = 0

)

const

Since

3.1

Saves the state of the model. The version number is stored as part of the state data.

To restore the saved state, pass the return value and version number to restoreState().

Definition at line 1304 of file ircbuffermodel.cpp.

References buffer(), buffers(), and IrcBuffer::title.

{
    Q_D(const IrcBufferModel);
    QVariantMap args;
    args.insert("version", version);

    QVariantMap states = d->bufferStates;
    foreach (IrcBuffer* buffer, d->bufferList)
        states.insert(buffer->title(), d->saveBuffer(buffer));

    QVariantList buffers;
    foreach (const QVariant& b, states)
        buffers += b;
    args.insert("buffers", buffers);

    QByteArray state;
    QDataStream out(&state, QIODevice::WriteOnly);
    out << args;
    return state;
}

Here is the call graph for this function:

restoreState()

bool IrcBufferModel::restoreState	(	const QByteArray &	state,
		int	version = 0
	)

Since

3.1

Restores the state of the model. The version number is compared with that stored in state. If they do not match, the model state is left unchanged, and this function returns false; otherwise, the state is restored, and true is returned.

See also

saveState()

Definition at line 1334 of file ircbuffermodel.cpp.

References _irc_restoreBuffers(), buffers(), and IRC_END_NAMESPACE.

{
    Q_D(IrcBufferModel);
    QVariantMap args;
    QDataStream in(state);
    in >> args;
    if (in.status() != QDataStream::Ok || args.value("version", -1).toInt() != version)
        return false;

    const QVariantList buffers = args.value("buffers").toList();
    foreach (const QVariant& v, buffers) {
        const QVariantMap b = v.toMap();
        d->bufferStates.insert(b.value("title").toString(), b);
    }

    if (d->joinDelay >= 0 && d->connection && d->connection->isConnected())
        QTimer::singleShot(d->joinDelay * 1000, this, SLOT(_irc_restoreBuffers()));

    return true;
}

Here is the call graph for this function:

clear

void IrcBufferModel::clear ( )

slot

Clears the model.

All buffers except persistent buffers are removed and destroyed.

In order to remove a persistent buffer, either explicitly call remove() or delete the buffer.

Definition at line 934 of file ircbuffermodel.cpp.

References buffer(), buffersChanged(), channelsChanged(), countChanged(), emptyChanged(), IrcBuffer::isChannel(), IrcBuffer::isPersistent(), and IrcBuffer::title.

{
    Q_D(IrcBufferModel);
    if (!d->bufferList.isEmpty()) {
        bool bufferRemoved = false;
        bool channelRemoved = false;
        foreach (IrcBuffer* buffer, d->bufferList) {
            if (!buffer->isPersistent()) {
                if (!bufferRemoved) {
                    beginResetModel();
                    bufferRemoved = true;
                }
                channelRemoved |= buffer->isChannel();
                buffer->disconnect(this);
                d->bufferList.removeOne(buffer);
                d->channels.removeOne(buffer->title());
                d->bufferMap.remove(buffer->title().toLower());
                delete buffer;
            }
        }
        if (bufferRemoved) {
            endResetModel();
            if (channelRemoved)
                emit channelsChanged(d->channels);
            emit buffersChanged(d->bufferList);
            emit countChanged(d->bufferList.count());
            if (d->bufferList.isEmpty())
                emit emptyChanged(true);
        }
    }
}

Here is the call graph for this function:

receiveMessage

void IrcBufferModel::receiveMessage ( IrcMessage *  message )

slot

Makes the model receive and handle message.

Definition at line 969 of file ircbuffermodel.cpp.

{
    Q_D(IrcBufferModel);
    d->messageFilter(message);
}

sort [1/2]

void IrcBufferModel::sort ( int  column = 0, Qt::SortOrder  order = Qt::AscendingOrder  )

slot

Sorts the model using the given order.

Definition at line 978 of file ircbuffermodel.cpp.

Referenced by setSortMethod(), and setSortOrder().

{
    Q_D(IrcBufferModel);
    if (column == 0)
        sort(d->sortMethod, order);
}

Here is the caller graph for this function:

sort [2/2]

void IrcBufferModel::sort ( Irc::SortMethod  method, Qt::SortOrder  order = Qt::AscendingOrder  )

slot

Sorts the model using the given method and order.

See also

lessThan()

Definition at line 990 of file ircbuffermodel.cpp.

References buffer(), index(), IrcBufferGreaterThan, IrcBufferLessThan, and Irc::SortByHand.

{
    Q_D(IrcBufferModel);
    if (method == Irc::SortByHand)
        return;

    emit layoutAboutToBeChanged();

    QList<IrcBuffer*> persistentBuffers;
    QModelIndexList oldPersistentIndexes = persistentIndexList();
    foreach (const QModelIndex& index, oldPersistentIndexes)
        persistentBuffers += static_cast<IrcBuffer*>(index.internalPointer());

    if (order == Qt::AscendingOrder)
        qSort(d->bufferList.begin(), d->bufferList.end(), IrcBufferLessThan(this, method));
    else
        qSort(d->bufferList.begin(), d->bufferList.end(), IrcBufferGreaterThan(this, method));

    QModelIndexList newPersistentIndexes;
    foreach (IrcBuffer* buffer, persistentBuffers)
        newPersistentIndexes += index(d->bufferList.indexOf(buffer));
    changePersistentIndexList(oldPersistentIndexes, newPersistentIndexes);

    emit layoutChanged();
}

Here is the call graph for this function:

countChanged

void IrcBufferModel::countChanged ( int  count )

signal

Referenced by clear().

Here is the caller graph for this function:

emptyChanged

void IrcBufferModel::emptyChanged ( bool  empty )

signal

Referenced by clear().

Here is the caller graph for this function:

added

void IrcBufferModel::added ( IrcBuffer *  buffer )

signal

This signal is emitted when a buffer is added to the list of buffers.

Referenced by dlgIRC::setupBuffers().

Here is the caller graph for this function:

removed

void IrcBufferModel::removed ( IrcBuffer *  buffer )

signal

This signal is emitted when a buffer is removed from the list of buffers.

Referenced by dlgIRC::setupBuffers().

Here is the caller graph for this function:

aboutToBeAdded

void IrcBufferModel::aboutToBeAdded ( IrcBuffer *  buffer )

signal

This signal is emitted just before a buffer is added to the list of buffers.

aboutToBeRemoved

void IrcBufferModel::aboutToBeRemoved ( IrcBuffer *  buffer )

signal

This signal is emitted just before a buffer is removed from the list of buffers.

persistentChanged

void IrcBufferModel::persistentChanged ( bool  persistent )

signal

Referenced by setPersistent().

Here is the caller graph for this function:

buffersChanged

void IrcBufferModel::buffersChanged ( const QList< IrcBuffer *> &  buffers )

signal

Referenced by clear().

Here is the caller graph for this function:

channelsChanged

void IrcBufferModel::channelsChanged ( const QStringList &  channels )

signal

Referenced by clear(), and dlgIRC::setupBuffers().

Here is the caller graph for this function:

connectionChanged

void IrcBufferModel::connectionChanged ( IrcConnection *  connection )

signal

Referenced by setConnection().

Here is the caller graph for this function:

networkChanged

void IrcBufferModel::networkChanged ( IrcNetwork *  network )

signal

Referenced by setConnection().

Here is the caller graph for this function:

messageIgnored

void IrcBufferModel::messageIgnored ( IrcMessage *  message )

signal

This signal is emitted when a message was ignored.

IrcBufferModel handles only buffer specific messages and delivers them to the appropriate IrcBuffer instances. When applications decide to handle IrcBuffer::messageReceived(), this signal makes it easy to implement handling for the rest, non-buffer specific messages.

See also

IrcConnection::messageReceived(), IrcBuffer::messageReceived()

Referenced by dlgIRC::setupBuffers().

Here is the caller graph for this function:

bufferPrototypeChanged

void IrcBufferModel::bufferPrototypeChanged ( IrcBuffer *  prototype )

signal

Referenced by setBufferPrototype().

Here is the caller graph for this function:

channelPrototypeChanged

void IrcBufferModel::channelPrototypeChanged ( IrcChannel *  prototype )

signal

Referenced by setChannelPrototype().

Here is the caller graph for this function:

destroyed

void IrcBufferModel::destroyed ( IrcBufferModel *  model )

signal

Referenced by ~IrcBufferModel().

Here is the caller graph for this function:

joinDelayChanged

void IrcBufferModel::joinDelayChanged ( int  delay )

signal

Referenced by setJoinDelay().

Here is the caller graph for this function:

monitorEnabledChanged

void IrcBufferModel::monitorEnabledChanged ( bool  enabled )

signal

Referenced by setMonitorEnabled().

Here is the caller graph for this function:

createBuffer

IrcBuffer * IrcBufferModel::createBuffer ( const QString &  title )

protectedvirtualslot

Creates a buffer object with title.

IrcBufferModel will automatically call this factory method when a need for the buffer object occurs ie. a private message is received.

The default implementation creates an instance of the buffer prototype. Reimplement this function in order to alter the default behavior.

See also

bufferPrototype

Definition at line 1027 of file ircbuffermodel.cpp.

{
    Q_D(IrcBufferModel);
    Q_UNUSED(title);
    QObject* instance = d->bufferProto->metaObject()->newInstance(Q_ARG(QObject*, this));
    return qobject_cast<IrcBuffer*>(instance);
}

createChannel

IrcChannel * IrcBufferModel::createChannel ( const QString &  title )

protectedvirtualslot

Creates a channel object with title.

IrcBufferModel will automatically call this factory method when a need for the channel object occurs ie. a channel is being joined.

The default implementation creates an instance of the channel prototype. Reimplement this function in order to alter the default behavior.

See also

channelPrototype

Definition at line 1046 of file ircbuffermodel.cpp.

{
    Q_D(IrcBufferModel);
    Q_UNUSED(title);
    QObject* instance = d->channelProto->metaObject()->newInstance(Q_ARG(QObject*, this));
    return qobject_cast<IrcChannel*>(instance);
}

lessThan()

bool IrcBufferModel::lessThan ( IrcBuffer *  one, IrcBuffer *  another, Irc::SortMethod  method  ) const

protectedvirtual

Returns true if one buffer is "less than" another, otherwise returns false.

The default implementation sorts according to the specified sort method. Reimplement this function in order to customize the sort order.

See also

sort(), sortMethod

Definition at line 1063 of file ircbuffermodel.cpp.

References IrcBufferPrivate::activity, IrcNetwork::channelTypes, IrcBufferPrivate::get(), IrcBuffer::isSticky(), IrcBuffer::name, IrcBuffer::network, IrcBuffer::prefix, Irc::SortByActivity, and Irc::SortByTitle.

Referenced by IrcBufferLessThan::operator()(), and IrcBufferGreaterThan::operator()().

{
    if (one->isSticky() != another->isSticky())
        return one->isSticky();

    if (method == Irc::SortByActivity) {
        QDateTime ts1 = IrcBufferPrivate::get(one)->activity;
        QDateTime ts2 = IrcBufferPrivate::get(another)->activity;
        if (ts1.isValid() || ts2.isValid())
            return ts1.isValid() && ts1 > ts2;
    }

    if (method == Irc::SortByTitle) {
        const QStringList prefixes = one->network()->channelTypes();

        const QString p1 = one->prefix();
        const QString p2 = another->prefix();

        const int i1 = !p1.isEmpty() ? prefixes.indexOf(p1.at(0)) : -1;
        const int i2 = !p2.isEmpty() ? prefixes.indexOf(p2.at(0)) : -1;

        if (i1 >= 0 && i2 < 0)
            return true;
        if (i1 < 0 && i2 >= 0)
            return false;
        if (i1 >= 0 && i2 >= 0 && i1 != i2)
            return i1 < i2;
    }

    // Irc::SortByName
    const QString n1 = one->name();
    const QString n2 = another->name();
    return n1.compare(n2, Qt::CaseInsensitive) < 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Q_PRIVATE_SLOT()

IrcBufferModel::Q_PRIVATE_SLOT ( d_func()  , void   _irc_connected()  )

private

_irc_initialized()

void IrcBufferModel::_irc_initialized ( )

private

Referenced by setConnection().

Here is the caller graph for this function:

_irc_disconnected()

void void IrcBufferModel::_irc_disconnected ( )

private

Referenced by setConnection().

Here is the caller graph for this function:

_irc_bufferDestroyed()

void void void IrcBufferModel::_irc_bufferDestroyed ( IrcBuffer *  )

private

_irc_restoreBuffers()

void void void void IrcBufferModel::_irc_restoreBuffers ( )

private

Referenced by restoreState().

Here is the caller graph for this function:

Friends And Related Function Documentation

IrcBufferLessThan

friend class IrcBufferLessThan

friend

Definition at line 156 of file ircbuffermodel.h.

Referenced by sort().

IrcBufferGreaterThan

friend class IrcBufferGreaterThan

friend

Definition at line 157 of file ircbuffermodel.h.

Referenced by sort().

Field Documentation

d_ptr

QScopedPointer<IrcBufferModelPrivate> IrcBufferModel::d_ptr

private

Definition at line 158 of file ircbuffermodel.h.

Property Documentation

count

int IrcBufferModel::count

read

This property holds the number of buffers.

Access function:

• int count() const

Notifier signal:

• void countChanged(int count)

Definition at line 50 of file ircbuffermodel.h.

empty

bool IrcBufferModel::empty

read

Since

3.1

This property holds the whether the model is empty.

Access function:

• bool isEmpty() const

Notifier signal:

• void emptyChanged(bool empty)

Definition at line 51 of file ircbuffermodel.h.

sortOrder

Qt::SortOrder IrcBufferModel::sortOrder

readwrite

This property holds the model sort order.

The default value is Qt::AscendingOrder.

Access functions:

• Qt::SortOrder sortOrder() const
• void setSortOrder(Qt::SortOrder order)

See also

sort(), lessThan()

Definition at line 52 of file ircbuffermodel.h.

sortMethod

Irc::SortMethod IrcBufferModel::sortMethod

readwrite

This property holds the model sort method.

The default value is Irc::SortByHand.

Method	Description	Example
Irc::SortByHand	Buffers are not sorted automatically, but only by calling sort().	-
Irc::SortByName	Buffers are sorted alphabetically, ignoring any channel prefix.	"bot", "#communi", "#freenode", "jpnurmi", "#qt"
Irc::SortByTitle	Buffers are sorted alphabetically, and channels before queries.	"#communi", "#freenode", "#qt", "bot", "jpnurmi"
Irc::SortByActivity	Buffers are sorted based on their messaging activity, last active buffers first.	-

Note

Irc::SortByActivity support was added in version 3.4.

Access functions:

• Irc::SortMethod sortMethod() const
• void setSortMethod(Irc::SortMethod method)

See also

sort(), lessThan()

Definition at line 53 of file ircbuffermodel.h.

channels

QStringList IrcBufferModel::channels

read

This property holds the list of channel names.

Access function:

• QStringList channels() const

Notifier signal:

• void channelsChanged(const QStringList& channels)

Definition at line 54 of file ircbuffermodel.h.

displayRole

Irc::DataRole IrcBufferModel::displayRole

readwrite

This property holds the display role.

The specified data role is returned for Qt::DisplayRole.

The default value is Irc::TitleRole.

Access functions:

• Irc::DataRole displayRole() const
• void setDisplayRole(Irc::DataRole role)

Definition at line 55 of file ircbuffermodel.h.

persistent

bool IrcBufferModel::persistent

readwrite

Since

3.1

This property holds whether the model is persistent.

The default value is false.

A persistent model does not remove and destruct channel buffers automatically when leaving the corresponding channels. In order to remove buffers from a persistent model, either call IrcBufferModel::remove() or delete the buffer.

Access functions:

• bool isPersistent() const
• void setPersistent(bool persistent)

Notifier signal:

• void persistentChanged(bool persistent)

Definition at line 56 of file ircbuffermodel.h.

Referenced by setPersistent().

buffers

QList< IrcBuffer * > IrcBufferModel::buffers

read

This property holds the list of buffers.

Access function:

• QList<IrcBuffer*> buffers() const

Notifier signal:

• void buffersChanged(const QList<IrcBuffer*>& buffers)

Definition at line 57 of file ircbuffermodel.h.

Referenced by dlgIRC::slot_onBufferAdded(), and dlgIRC::slot_onUserActivated().

connection

IrcConnection * IrcBufferModel::connection

readwrite

This property holds the connection.

Access functions:

• IrcConnection* connection() const
• void setConnection(IrcConnection* connection)

Warning

Changing the connection on the fly is not supported.

Definition at line 58 of file ircbuffermodel.h.

network

IrcNetwork * IrcBufferModel::network

read

This property holds the network.

Access functions:

• IrcNetwork* network() const

Definition at line 59 of file ircbuffermodel.h.

Referenced by IrcChannelPrivate::init(), and IrcChannelPrivate::setUserMode().

bufferPrototype

IrcBuffer * IrcBufferModel::bufferPrototype

readwrite

This property holds the buffer prototype.

The prototype is used by the default implementation of createBuffer().

Note

The prototype must have an invokable constructor.

Access functions:

• IrcBuffer* bufferPrototype() const
• void setBufferPrototype(IrcBuffer* prototype)

Definition at line 60 of file ircbuffermodel.h.

channelPrototype

IrcChannel * IrcBufferModel::channelPrototype

readwrite

This property holds the channel prototype.

The prototype is used by the default implementation of createChannel().

Note

The prototype must have an invokable constructor.

Access functions:

• IrcChannel* channelPrototype() const
• void setChannelPrototype(IrcChannel* prototype)

Definition at line 61 of file ircbuffermodel.h.

joinDelay

int IrcBufferModel::joinDelay

readwrite

Since

3.3

This property holds the join delay in seconds.

The default value is 0 - channels are joined immediately after getting connected. A negative value disables automatic joining of channels.

Access function:

• int joinDelay() const
• void setJoinDelay(int delay)

Notifier signal:

• void joinDelayChanged(int delay)

Definition at line 62 of file ircbuffermodel.h.

monitorEnabled

bool IrcBufferModel::monitorEnabled

readwrite

Since

3.4

This property holds whether automatic monitor is enabled.

The default value is false.

Access function:

• bool isMonitorEnabled() const
• void setMonitorEnabled(bool enabled)

Notifier signal:

• void monitorEnabledChanged(bool enabled)

See also

ircv3

Definition at line 63 of file ircbuffermodel.h.

---

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

• Mudlet-development/3rdparty/communi/include/IrcModel/ircbuffermodel.h
• Mudlet-development/3rdparty/communi/src/model/ircbuffermodel.cpp