QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Types | Signals | Public Member Functions | List of all members
QgsGroupUngroupItemsCommand Class Reference

A composer command class for grouping / ungrouping composer items. More...

#include <qgsgroupungroupitemscommand.h>

Inheritance diagram for QgsGroupUngroupItemsCommand:
Inheritance graph
[legend]

Public Types

enum  State { Grouped = 0, Ungrouped }
 Command kind, and state. More...
 

Signals

void itemAdded (QgsComposerItem *item)
 Signals addition of an item (the group) More...
 
void itemRemoved (QgsComposerItem *item)
 Signals removal of an item (the group) More...
 

Public Member Functions

 QgsGroupUngroupItemsCommand (State s, QgsComposerItemGroup *item, QgsComposition *c, const QString &text, QUndoCommand *parent=nullptr)
 Create a group or ungroup command. More...
 
 ~QgsGroupUngroupItemsCommand ()
 
void redo () override
 
void undo () override
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 
- Public Member Functions inherited from QUndoCommand
 QUndoCommand (QUndoCommand *parent)
 
 QUndoCommand (const QString &text, QUndoCommand *parent)
 
virtual ~QUndoCommand ()
 
QString actionText () const
 
const QUndoCommandchild (int index) const
 
int childCount () const
 
virtual int id () const
 
virtual bool mergeWith (const QUndoCommand *command)
 
void setText (const QString &text)
 
QString text () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A composer command class for grouping / ungrouping composer items.

If mState == Ungrouped, the command owns the group item

Definition at line 31 of file qgsgroupungroupitemscommand.h.

Member Enumeration Documentation

◆ State

Command kind, and state.

Enumerator
Grouped 
Ungrouped 

Definition at line 38 of file qgsgroupungroupitemscommand.h.

Constructor & Destructor Documentation

◆ QgsGroupUngroupItemsCommand()

QgsGroupUngroupItemsCommand::QgsGroupUngroupItemsCommand ( State  s,
QgsComposerItemGroup item,
QgsComposition c,
const QString text,
QUndoCommand parent = nullptr 
)

Create a group or ungroup command.

Parameters
scommand kind (
See also
State)
Parameters
itemthe group item being created or ungrouped
cthe composition including this group
textcommand label
parentparent command, if any

Definition at line 26 of file qgsgroupungroupitemscommand.cpp.

◆ ~QgsGroupUngroupItemsCommand()

QgsGroupUngroupItemsCommand::~QgsGroupUngroupItemsCommand ( )

Definition at line 32 of file qgsgroupungroupitemscommand.cpp.

Member Function Documentation

◆ itemAdded

void QgsGroupUngroupItemsCommand::itemAdded ( QgsComposerItem item)
signal

Signals addition of an item (the group)

◆ itemRemoved

void QgsGroupUngroupItemsCommand::itemRemoved ( QgsComposerItem item)
signal

Signals removal of an item (the group)

◆ redo()

void QgsGroupUngroupItemsCommand::redo ( )
overridevirtual

Reimplemented from QUndoCommand.

Definition at line 41 of file qgsgroupungroupitemscommand.cpp.

◆ undo()

void QgsGroupUngroupItemsCommand::undo ( )
overridevirtual

Reimplemented from QUndoCommand.

Definition at line 51 of file qgsgroupungroupitemscommand.cpp.


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