Class TUndoItem

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TUndoItem = class(TObject)

Description

TUndoItem is an abstract interface for a command. Descendants define what the command does and how to undo and redo the command.

This is an ancestral type; different forms can inherit this and modify it to meet needs of data on that form.

Hierarchy

Overview

Methods

Protected function GetUndoDescription: string; virtual;
Protected function GetShortUndoDescription: string; virtual;
Protected function GetRedoDescription: string; virtual;
Protected function GetShortRedoDescription: string; virtual;
Protected function GetUndoMenuText: string; virtual;
Protected function GetRedoMenuText: string; virtual;
Public procedure DoCommand; virtual; abstract;
Public procedure Undo; virtual; abstract;
Public procedure Redo; virtual; abstract;

Properties

Public property UndoDescription: string read GetUndoDescription;
Public property ShortUndoDescription: string read GetShortUndoDescription;
Public property RedoDescription: string read GetRedoDescription;
Public property ShortRedoDescription: string read GetShortRedoDescription;
Public property UndoMenuText: string read GetUndoMenuText;
Public property RedoMenuText: string read GetRedoMenuText;

Description

Methods

Protected function GetUndoDescription: string; virtual;

GetUndoDescription is a description of what is to be undone.

Protected function GetShortUndoDescription: string; virtual;

GetShortUndoDescription is a short description of what is to be undone.

Protected function GetRedoDescription: string; virtual;

GetRedoDescription is a description of what is to be redone.

Protected function GetShortRedoDescription: string; virtual;

GetShortRedoDescription is a short description of what is to be redone.

Protected function GetUndoMenuText: string; virtual;

GetUndoMenuText is text to display for a menu item that undoes the action.

Protected function GetRedoMenuText: string; virtual;

GetRedoMenuText is text to display for a menu item that redoes the action.

Public procedure DoCommand; virtual; abstract;

DoCommand does the command for the first time.

Public procedure Undo; virtual; abstract;

Undo undoes the command.

Public procedure Redo; virtual; abstract;

Redo redoes the command after being undone.

Properties

Public property UndoDescription: string read GetUndoDescription;

UndoDescription is a description of what is to be undone.

Public property ShortUndoDescription: string read GetShortUndoDescription;

ShortUndoDescription is a short description of what is to be undone.

Public property RedoDescription: string read GetRedoDescription;

RedoDescription is a description of what is to be redone.

Public property ShortRedoDescription: string read GetShortRedoDescription;

ShortRedoDescription is a short description of what is to be redone.

Public property UndoMenuText: string read GetUndoMenuText;

UndoMenuText is text to display for a menu item that undoes the action.

Public property RedoMenuText: string read GetRedoMenuText;

RedoMenuText is text to display for a menu item that redoes the action.


Generated by PasDoc 0.12.1 on 2013-05-13 15:42:06