Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

UndoGui Class Reference

UndoGui is a virtual superclass for undo/redo widgets. More...

#include <undogui.h>

Inheritance diagram for UndoGui:

Inheritance graph
[legend]
Collaboration diagram for UndoGui:

Collaboration graph
[legend]

List of all members.

Public Slots

virtual void insertUndoItem (UndoObject *target, UndoState *state)=0
 Insert a new undo item.
virtual void insertRedoItem (UndoObject *target, UndoState *state)=0
 Insert a new redo item.
virtual void updateUndo (int steps)=0
 Update undo stack representation with number of steps.
virtual void updateRedo (int steps)=0
 Update redo stack representation with number of steps.
virtual void updateUndoActions ()=0
 Update the scrActions.
virtual void clearRedo ()=0
 Clear the redo action items.
virtual void popBack ()=0
 Remove the last (oldest) item from the undo stack representation.

Public Member Functions

 UndoGui (QWidget *parent=0, const char *name="UndoGui", Qt::WFlags f=0)
 Creates a new UndoGui instance.
virtual ~UndoGui ()
 Destroys the widget.
virtual void clear ()=0
 Empties the undo stack representation.


Detailed Description

UndoGui is a virtual superclass for undo/redo widgets.

UndoGui is a virtual superclass for all the classes that wants to represent undo/redo data. Subclasses must be registered to the UndoManager instance. Subclasses are expected to keep the whole stack with them and they must be able to work undo/redo situations by themselves. Only new undo actions and steps (undo or redo) are reported back.

See also:
UndoWidget

UndoPalette

Author:
Riku Leino tsoots@gmail.com
Date:
December 2004

Definition at line 57 of file undogui.h.


Constructor & Destructor Documentation

UndoGui::UndoGui ( QWidget *  parent = 0,
const char *  name = "UndoGui",
Qt::WFlags  f = 0 
)

Creates a new UndoGui instance.

Parameters:
parent Parent object for UndoGui
name Name of the object
f widget flags

Definition at line 39 of file undogui.cpp.

virtual UndoGui::~UndoGui (  )  [inline, virtual]

Destroys the widget.

Definition at line 71 of file undogui.h.


Member Function Documentation

virtual void UndoGui::clear (  )  [pure virtual]

Empties the undo stack representation.

Implemented in UndoWidget, and UndoPalette.

Referenced by UndoManager::setState().

virtual void UndoGui::insertUndoItem ( UndoObject target,
UndoState state 
) [pure virtual, slot]

Insert a new undo item.

Insert a new undo item. After an undoable action has happened and if this UndoGui is registered to the UndoManager this slot will be used to register the action to the widget.

Parameters:
target Target of the undo action
state State describing the action

Implemented in UndoWidget, and UndoPalette.

Referenced by UndoManager::setState().

virtual void UndoGui::insertRedoItem ( UndoObject target,
UndoState state 
) [pure virtual, slot]

Insert a new redo item.

Parameters:
target Target of the redo action
state State describing the action

Implemented in UndoWidget, and UndoPalette.

Referenced by UndoManager::setState().

virtual void UndoGui::updateUndo ( int  steps  )  [pure virtual, slot]

Update undo stack representation with number of steps.

When some other UndoGui subclass has received an undo request this slot is used to inform this UndoGui to update it's UndoStack representation.

Parameters:
steps Number of steps to take

Implemented in UndoWidget, and UndoPalette.

virtual void UndoGui::updateRedo ( int  steps  )  [pure virtual, slot]

Update redo stack representation with number of steps.

When some other registered UndoGui subclass has received a redo request this slot is used to inform this UndoGui to update it's undo stack representation.

Parameters:
steps Number of steps to take

Implemented in UndoWidget, and UndoPalette.

virtual void UndoGui::updateUndoActions (  )  [pure virtual, slot]

Update the scrActions.

Implemented in UndoWidget, and UndoPalette.

Referenced by UndoManager::connectGuis().

virtual void UndoGui::clearRedo (  )  [pure virtual, slot]

Clear the redo action items.

Implemented in UndoWidget, and UndoPalette.

virtual void UndoGui::popBack (  )  [pure virtual, slot]

Remove the last (oldest) item from the undo stack representation.

Implemented in UndoWidget, and UndoPalette.


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.