Seg3D::UndoBuffer Class Reference

Inheritance diagram for Seg3D::UndoBuffer:

Public Types
typedef boost::signals2::signal< void(std::string) >	update_undo_tag_signal_type
typedef boost::signals2::signal< void(std::string) >	update_redo_tag_signal_type
typedef boost::signals2::signal< void() >	buffer_changed_signal_type

Public Member Functions
void	insert_undo_item (Core::ActionContextHandle context, UndoBufferItemHandle undo_item)
bool	undo (Core::ActionContextHandle context)
bool	redo (Core::ActionContextHandle context)
void	reset_undo_buffer ()
std::string	get_undo_tag (size_t index=0) const
size_t	get_undo_byte_size (size_t index=0) const
std::string	get_redo_tag (size_t index=0) const
size_t	get_redo_byte_size (size_t index=0) const
bool	has_undo () const
bool	has_redo () const
size_t	num_undo_items ()
size_t	num_redo_items ()

Public Attributes
update_undo_tag_signal_type	update_undo_tag_signal_
update_redo_tag_signal_type	update_redo_tag_signal_
buffer_changed_signal_type	buffer_changed_signal_

Member Function Documentation

size_t Seg3D::UndoBuffer::get_redo_byte_size

(

size_t

index = 0

)

const

GET_REDO_BYTE_SIZE: Get the tag from the action stored on top of the undo stack. NOTE: if an empty string is returned the undo stack is empty.

std::string Seg3D::UndoBuffer::get_redo_tag

(

size_t

index = 0

)

const

GET_REDO_TAG: Get the tag from the action stored on top of the redo stack. NOTE: if an empty string is returned the redo stack is empty.

size_t Seg3D::UndoBuffer::get_undo_byte_size

(

size_t

index = 0

)

const

GET_UNDO_BYTE_SIZE: Get the tag from the action stored on top of the undo stack. NOTE: if an empty string is returned the undo stack is empty.

std::string Seg3D::UndoBuffer::get_undo_tag

(

size_t

index = 0

)

const

GET_UNDO_TAG: Get the tag from the action stored on top of the undo stack. NOTE: if an empty string is returned the undo stack is empty.

bool Seg3D::UndoBuffer::has_redo

(

)

const

HAS_REDO: Check whether there is something to redo

bool Seg3D::UndoBuffer::has_undo

(

)

const

HAS_UNDO: Check whether there is something to undo

void Seg3D::UndoBuffer::insert_undo_item	(	Core::ActionContextHandle	context,
		UndoBufferItemHandle	undo_item
	)

INSERT_UNDO_ITEM: Insert a new undo item in the queue NOTE: The action context is needed to verify whether it is inserted from the undo buffer itself or whether the undo item was created in a normal action.

size_t Seg3D::UndoBuffer::num_redo_items

(

)

NUM_REDO_ITEMS: Get the number of redo items on the stack

size_t Seg3D::UndoBuffer::num_undo_items

(

)

NUM_UNDO_ITEMS: Get the number of undo items on the stack

bool Seg3D::UndoBuffer::redo

(

Core::ActionContextHandle

context

)

REDO: redo the top item of the stack

void Seg3D::UndoBuffer::reset_undo_buffer

(

)

RESET_UNDO_BUFFER: Reset the buffer to its initial setting

bool Seg3D::UndoBuffer::undo

(

Core::ActionContextHandle

context

)

UNDO: Undo the top item of the stack

Member Data Documentation

buffer_changed_signal_type Seg3D::UndoBuffer::buffer_changed_signal_

BUFFER_CHANGED_SIGNAL: This signal is triggered whenever the buffer changes its contents

update_redo_tag_signal_type Seg3D::UndoBuffer::update_redo_tag_signal_

UPDATE_REDO_TAG_SIGNAL: This signal is triggered when a new redo item is on top of the redo stack

update_undo_tag_signal_type Seg3D::UndoBuffer::update_undo_tag_signal_

UPDATE_UNDO_TAG_SIGNAL: This signal is triggered when a new undo item is on top of the undo stack

---

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

• Application/UndoBuffer/UndoBuffer.h
• Application/UndoBuffer/UndoBuffer.cc