Permalink
Browse files
[FEATURE][composer] Implement an item tree panel for composer windows
(fix #4358). Allows for selection of items, hiding/showing items, toggling lock status of items and double-clicking to edit item id.
- Loading branch information
Showing
with
1,527 additions
and 185 deletions.
- +18 −0 python/core/composer/qgscomposeritem.sip
- +194 −0 python/core/composer/qgscomposermodel.sip
- +22 −10 python/core/composer/qgscomposition.sip
- +1 −0 python/core/core.sip
- +31 −0 src/app/composer/qgscomposer.cpp
- +5 −0 src/app/composer/qgscomposer.h
- +2 −0 src/core/CMakeLists.txt
- +3 −0 src/core/composer/qgsaddremoveitemcommand.cpp
- +45 −1 src/core/composer/qgscomposeritem.cpp
- +22 −0 src/core/composer/qgscomposeritem.h
- +4 −0 src/core/composer/qgscomposeritemgroup.cpp
- +23 −0 src/core/composer/qgscomposerlabel.cpp
- +1 −1 src/core/composer/qgscomposerlabel.h
- +740 −0 src/core/composer/qgscomposermodel.cpp
- +271 −0 src/core/composer/qgscomposermodel.h
- +17 −0 src/core/composer/qgscomposershape.cpp
- +1 −1 src/core/composer/qgscomposershape.h
- +97 −158 src/core/composer/qgscomposition.cpp
- +28 −13 src/core/composer/qgscomposition.h
- +2 −1 src/gui/qgscomposerview.cpp
| @@ -0,0 +1,194 @@ | ||
| /** | ||
| * \class QgsComposerModel | ||
| * \ingroup MapComposer | ||
| * | ||
| * A model for items attached to a composition. The model also maintains the z-order for the | ||
| * composition, and must be notified whenever item stacking changes. | ||
| * | ||
| * Internally, QgsComposerModel maintains two lists. One contains a complete list of all items for | ||
| * the composition, ordered by their position within the z-order stack. This list also contains | ||
| * items which have been removed from the composition, so that undo/redo commands can restore | ||
| * them to their correct position in the stacking order. | ||
| * | ||
| * The second list contains only items which are currently displayed in the composition's scene. | ||
| * It is used as a cache of the last known stacking order, so that the model can compare the current | ||
| * stacking of items in the composition to the last known state, and emit the corresponding signals | ||
| * as required. | ||
| */ | ||
|
|
||
| class QgsComposerModel : QAbstractItemModel | ||
| { | ||
| %TypeHeaderCode | ||
| #include "qgscomposermodel.h" | ||
| %End | ||
| public: | ||
|
|
||
| /**Constructor | ||
| * @param composition parent composition | ||
| */ | ||
| explicit QgsComposerModel( QgsComposition* composition, QObject* parent = 0 ); | ||
|
|
||
| ~QgsComposerModel(); | ||
|
|
||
| //reimplemented QAbstractItemModel methods | ||
| QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const; | ||
| QModelIndex parent( const QModelIndex &index ) const; | ||
| int rowCount( const QModelIndex &parent = QModelIndex() ) const; | ||
| int columnCount( const QModelIndex &parent = QModelIndex() ) const; | ||
| QVariant data( const QModelIndex &index, int role ) const; | ||
| Qt::ItemFlags flags( const QModelIndex & index ) const; | ||
| bool setData( const QModelIndex & index, const QVariant & value, int role ); | ||
| QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; | ||
|
|
||
| /**Clears all items from z-order list and resets the model | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void clear(); | ||
|
|
||
| /**Returns the size of the z-order list, which includes items which may | ||
| * have been removed from the composition. | ||
| * @returns size of z-order list | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| int zOrderListSize() const; | ||
|
|
||
| /**Rebuilds the z-order list, based on the current stacking of items in the composition. | ||
| * This method should be called after adding multiple items to the composition. | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void rebuildZList(); | ||
|
|
||
| /**Adds an item to the top of the composition z stack. | ||
| * @param item item to add. The item must not already exist in the z-order list. | ||
| * @note added in QGIS 2.5 | ||
| * @see reorderItemToTop | ||
| */ | ||
| void addItemAtTop( QgsComposerItem *item ); | ||
|
|
||
| /**Removes an item from the z-order list. | ||
| * @param item item to remove | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void removeItem( QgsComposerItem *item ); | ||
|
|
||
| /**Moves an item up the z-order list. | ||
| * @param item item to move | ||
| * @returns true if item was moved. Returns false if item was not found | ||
| * in z-order list or was already at the top of the z-order list. | ||
| * @see reorderItemDown | ||
| * @see reorderItemToTop | ||
| * @see reorderItemToBottom | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| bool reorderItemUp( QgsComposerItem *item ); | ||
|
|
||
| /**Moves an item down the z-order list. | ||
| * @param item item to move | ||
| * @returns true if item was moved. Returns false if item was not found | ||
| * in z-order list or was already at the bottom of the z-order list. | ||
| * @see reorderItemUp | ||
| * @see reorderItemToTop | ||
| * @see reorderItemToBottom | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| bool reorderItemDown( QgsComposerItem *item ); | ||
|
|
||
| /**Moves an item to the top of the z-order list. | ||
| * @param item item to move | ||
| * @returns true if item was moved. Returns false if item was not found | ||
| * in z-order list or was already at the top of the z-order list. | ||
| * @see reorderItemUp | ||
| * @see reorderItemDown | ||
| * @see reorderItemToBottom | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| bool reorderItemToTop( QgsComposerItem *item ); | ||
|
|
||
| /**Moves an item to the bottom of the z-order list. | ||
| * @param item item to move | ||
| * @returns true if item was moved. Returns false if item was not found | ||
| * in z-order list or was already at the bottom of the z-order list. | ||
| * @see reorderItemUp | ||
| * @see reorderItemDown | ||
| * @see reorderItemToTop | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| bool reorderItemToBottom( QgsComposerItem *item ); | ||
|
|
||
| /**Finds the next composer item above an item. This method only considers | ||
| * items which are currently in the composition, and ignores items which have been | ||
| * removed from the composition. | ||
| * @param item item to search above | ||
| * @returns item above specified item. If no items were found, no item | ||
| * will be returned. | ||
| * @see getComposerItemBelow | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| QgsComposerItem* getComposerItemAbove( QgsComposerItem *item ) const; | ||
|
|
||
| /**Finds the next composer item below an item. This method only considers | ||
| * items which are currently in the composition, and ignores items which have been | ||
| * removed from the composition. | ||
| * @param item item to search above | ||
| * @returns item below specified item. If no items were found, no item | ||
| * will be returned. | ||
| * @see getComposerItemAbove | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| QgsComposerItem* getComposerItemBelow( QgsComposerItem *item ) const; | ||
|
|
||
| /**Returns the item z-order list. This list includes both items currently in the | ||
| * composition and items which have been removed from the composition. | ||
| * @returns item z-order list | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| QList<QgsComposerItem *>* zOrderList(); | ||
|
|
||
| /**Marks an item as removed from the composition. This must be called whenever an item | ||
| * has been removed from the composition. | ||
| * @param item to mark as removed from the composition | ||
| * @see setItemRestored | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void setItemRemoved( QgsComposerItem *item ); | ||
|
|
||
| /**Restores an item to the composition. This must be called whenever an item removed | ||
| * from the composition is restored to the composition. | ||
| * @param item to mark as restored to the composition | ||
| * @see setItemRemoved | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void setItemRestored( QgsComposerItem *item ); | ||
|
|
||
| /**Must be called when an item's display name is modified | ||
| * @param item item to update | ||
| * @see updateItemLockStatus | ||
| * @see updateItemVisibility | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void updateItemDisplayName( QgsComposerItem *item ); | ||
|
|
||
| /**Must be called when an item's lock status changes | ||
| * @param item item to update | ||
| * @see updateItemDisplayName | ||
| * @see updateItemVisibility | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void updateItemLockStatus( QgsComposerItem *item ); | ||
|
|
||
| /**Must be called when an item's visibility changes | ||
| * @param item item to update | ||
| * @see updateItemDisplayName | ||
| * @see updateItemLockStatus | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void updateItemVisibility( QgsComposerItem *item ); | ||
|
|
||
| public slots: | ||
|
|
||
| /**Sets an item as the current selection from a QModelIndex | ||
| * @param index QModelIndex of item to set as selected | ||
| * @note added in QGIS 2.5 | ||
| */ | ||
| void setSelected( const QModelIndex &index ); | ||
| }; |
Oops, something went wrong.