Skip to content
Permalink
Browse files
[layertree] Added QgsLayerTreeModel doxygen docs + minor API changes
  • Loading branch information
wonder-sk committed May 27, 2014
1 parent b49ce33 commit df0991084666a6dac81a7d05397b2c75fee59611
Showing with 101 additions and 21 deletions.
  1. +2 −2 src/app/qgisapp.cpp
  2. +44 −0 src/gui/layertree/qgslayertreemodel.cpp
  3. +53 −16 src/gui/layertree/qgslayertreemodel.h
  4. +2 −3 src/gui/layertree/qgslayertreeview.cpp
@@ -397,7 +397,7 @@ void QgisApp::emitCustomSrsValidation( QgsCoordinateReferenceSystem &srs )
void QgisApp::layerTreeViewDoubleClicked( const QModelIndex& index )
{
// temporary solution for WMS legend
if ( mLayerTreeView->layerTreeModel()->index2symnode( index ) )
if ( mLayerTreeView->layerTreeModel()->isIndexSymbologyNode( index ) )
{
QModelIndex parent = mLayerTreeView->layerTreeModel()->parent( index );
QgsLayerTreeNode* node = mLayerTreeView->layerTreeModel()->index2node( parent );
@@ -9556,7 +9556,7 @@ void QgisApp::writeProject( QDomDocument &doc )
QgsLayerTreeNode* clonedRoot = QgsProject::instance()->layerTreeRoot()->clone();
QgsLayerTreeUtils::removeChildrenOfEmbeddedGroups( QgsLayerTree::toGroup( clonedRoot ) );
QDomElement oldLegendElem = QgsLayerTreeUtils::writeOldLegend( doc, QgsLayerTree::toGroup( clonedRoot ),
mLayerTreeCanvasBridge->hasCustomLayerOrder(), mLayerTreeCanvasBridge->customLayerOrder() );
mLayerTreeCanvasBridge->hasCustomLayerOrder(), mLayerTreeCanvasBridge->customLayerOrder() );
delete clonedRoot;
doc.firstChildElement( "qgis" ).appendChild( oldLegendElem );

@@ -398,6 +398,22 @@ QList<QgsLayerTreeNode*> QgsLayerTreeModel::indexes2nodes( const QModelIndexList
return nodesFinal;
}

bool QgsLayerTreeModel::isIndexSymbologyNode( const QModelIndex& index ) const
{
return index2symnode( index ) != 0;
}

QgsLayerTreeLayer* QgsLayerTreeModel::layerNodeForSymbologyNode( const QModelIndex& index ) const
{
QgsLayerTreeModelSymbologyNode* symNode = index2symnode( index );
return symNode ? symNode->parent() : 0;
}

QgsLayerTreeGroup*QgsLayerTreeModel::rootGroup()
{
return mRootNode;
}

void QgsLayerTreeModel::refreshLayerSymbology( QgsLayerTreeLayer* nodeLayer )
{
// update title
@@ -412,6 +428,11 @@ void QgsLayerTreeModel::refreshLayerSymbology( QgsLayerTreeLayer* nodeLayer )
addSymbologyToLayer( nodeLayer );
}

QModelIndex QgsLayerTreeModel::currentIndex() const
{
return mCurrentIndex;
}

void QgsLayerTreeModel::setCurrentIndex( const QModelIndex& currentIndex )
{
QModelIndex oldIndex = mCurrentIndex;
@@ -808,6 +829,29 @@ bool QgsLayerTreeModel::removeRows( int row, int count, const QModelIndex& paren
return false;
}

void QgsLayerTreeModel::setFlags( QgsLayerTreeModel::Flags f )
{
mFlags = f;
}

void QgsLayerTreeModel::setFlag( QgsLayerTreeModel::Flag f, bool on )
{
if ( on )
mFlags |= f;
else
mFlags &= ~f;
}

QgsLayerTreeModel::Flags QgsLayerTreeModel::flags() const
{
return mFlags;
}

bool QgsLayerTreeModel::testFlag( QgsLayerTreeModel::Flag f ) const
{
return mFlags.testFlag( f );
}


const QIcon& QgsLayerTreeModel::iconGroup()
{
@@ -45,14 +45,31 @@ class QgsLayerTreeModelSymbologyNode : public QObject
};



/**
* The QgsLayerTreeModel class is model implementation for Qt item views framework.
* The model can be used in any QTreeView, it is however recommended to use it
* with QgsLayerTreeView which brings additional functionality specific to layer tree handling.
*
* The model listens to the changes in the layer tree and signals the changes as appropriate,
* so that any view that uses the model is updated accordingly.
*
* Behavior of the model can be customized with flags. For example, whether to show symbology or
* whether to allow changes to the layer tree.
*
* @see QgsLayerTreeView
* @note added in 2.4
*/
class GUI_EXPORT QgsLayerTreeModel : public QAbstractItemModel
{
Q_OBJECT
public:
//! Construct a new tree model with given layer tree (root node must not be null pointer).
//! The root node is not transferred by the model.
explicit QgsLayerTreeModel( QgsLayerTreeGroup* rootNode, QObject *parent = 0 );
~QgsLayerTreeModel();

// Implementation of virtual functions from QAbstractItemModel

int rowCount( const QModelIndex &parent = QModelIndex() ) const;
int columnCount( const QModelIndex &parent = QModelIndex() ) const;
QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;
@@ -64,9 +81,10 @@ class GUI_EXPORT QgsLayerTreeModel : public QAbstractItemModel
QStringList mimeTypes() const;
QMimeData* mimeData( const QModelIndexList& indexes ) const;
bool dropMimeData( const QMimeData* data, Qt::DropAction action, int row, int column, const QModelIndex& parent );

bool removeRows( int row, int count, const QModelIndex& parent = QModelIndex() );

// New stuff

enum Flag
{
// display flags
@@ -79,24 +97,39 @@ class GUI_EXPORT QgsLayerTreeModel : public QAbstractItemModel
};
Q_DECLARE_FLAGS( Flags, Flag )

void setFlags( Flags f ) { mFlags = f; }
void setFlag( Flag f, bool on = true ) { if ( on ) mFlags |= f; else mFlags &= ~f; }
Flags flags() const { return mFlags; }
bool testFlag( Flag f ) const { return mFlags.testFlag( f ); }

// conversion functions used by views

//! Set OR-ed combination of model flags
void setFlags( Flags f );
//! Enable or disable a model flag
void setFlag( Flag f, bool on = true );
//! Return OR-ed combination of model flags
Flags flags() const;
//! Check whether a flag is enabled
bool testFlag( Flag f ) const;

//! Return layer tree node for given index. Returns root node for invalid index.
//! Returns null pointer if index does not refer to a layer tree node (e.g. it is a symbology item)
QgsLayerTreeNode* index2node( const QModelIndex& index ) const;
static QgsLayerTreeModelSymbologyNode* index2symnode( const QModelIndex& index );
//! Return index for a given node. If the node does not belong to the layer tree, the result is undefined
QModelIndex node2index( QgsLayerTreeNode* node ) const;

//! Convert a list of indexes to a list of layer tree nodes.
//! Indices that do not represent layer tree nodes are skipped.
//! @arg skipInternal If true, a node is included in the output list only if no parent node is in the list
QList<QgsLayerTreeNode*> indexes2nodes( const QModelIndexList& list, bool skipInternal = false ) const;
//! Return true if index represents a symbology node (instead of layer node)
bool isIndexSymbologyNode( const QModelIndex& index ) const;
//! Return layer node to which a symbology node belongs to. Returns null pointer if index is not a symbology node.
QgsLayerTreeLayer* layerNodeForSymbologyNode( const QModelIndex& index ) const;

QgsLayerTreeGroup* rootGroup() { return mRootNode; }
//! Return pointer to the root node of the layer tree. Always a non-null pointer.
QgsLayerTreeGroup* rootGroup();

//! Force a refresh of symbology of layer node.
//! Not necessary to call when layer's renderer is changed as the model listens to these events.
void refreshLayerSymbology( QgsLayerTreeLayer* nodeLayer );

QModelIndex currentIndex() const { return mCurrentIndex; }
//! Get index of the item marked as current. Item marked as current is underlined.
QModelIndex currentIndex() const;
//! Set index of the current item. May be used by view. Item marked as current is underlined.
void setCurrentIndex( const QModelIndex& currentIndex );

signals:
@@ -124,14 +157,18 @@ class GUI_EXPORT QgsLayerTreeModel : public QAbstractItemModel
void connectToLayer( QgsLayerTreeLayer* nodeLayer );
void disconnectFromLayer( QgsLayerTreeLayer* nodeLayer );

static QgsLayerTreeModelSymbologyNode* index2symnode( const QModelIndex& index );

static const QIcon& iconGroup();

protected:
QgsLayerTreeGroup* mRootNode; // not owned!
//! Pointer to the root node of the layer tree. Not owned by the model
QgsLayerTreeGroup* mRootNode;
//! Set of flags for the model
Flags mFlags;

//! Data structure for storage of symbology nodes for each layer
QMap<QgsLayerTreeLayer*, QList<QgsLayerTreeModelSymbologyNode*> > mSymbologyNodes;

//! Current index - will be underlined
QPersistentModelIndex mCurrentIndex;
};

@@ -177,9 +177,8 @@ QgsMapLayer* QgsLayerTreeView::layerForIndex( const QModelIndex& index ) const
else
{
// possibly a symbology node
QgsLayerTreeModelSymbologyNode* symnode = layerTreeModel()->index2symnode( index );
if ( symnode )
return symnode->parent()->layer();
if ( layerTreeModel()->isIndexSymbologyNode( index ) )
return layerTreeModel()->layerNodeForSymbologyNode( index )->layer();
}

return 0;

0 comments on commit df09910

Please sign in to comment.