fe::IEditorFacadeListener Class Reference
[Ferry Core library]

The listener class for receiving editor events. More...

Inheritance diagram for fe::IEditorFacadeListener:

List of all members.

Public Member Functions
virtual void UC_DLL_CALL	onCursorPosChanged (FeHandle *sender, unsigned byteIdx)=0
virtual void UC_DLL_CALL	onDecoratorFailed (FeHandle *sender)=0
virtual void UC_DLL_CALL	onDestroyed (FeHandle *sender)=0
virtual void UC_DLL_CALL	onSharedOffscreenBufferAttached (FeHandle *sender)=0
virtual void UC_DLL_CALL	onSharedOffscreenBufferDetached (FeHandle *sender)=0
virtual void UC_DLL_CALL	onTextErase (FeHandle *sender, unsigned byteIdx, unsigned lines, unsigned bytes)=0
virtual void UC_DLL_CALL	onTextInsert (FeHandle *sender, unsigned byteIdx, unsigned lines, unsigned bytes)=0
virtual void UC_DLL_CALL	onTextViewportChanged (FeHandle *sender, unsigned x, unsigned y, unsigned w, unsigned h)=0
virtual void UC_DLL_CALL	onVisibleTextChanged (FeHandle *sender, unsigned lineIdx, unsigned offset, unsigned lines, unsigned bytes)=0

---

Detailed Description

The listener class for receiving editor events.

The class that is interested in processing editor events implements this class, and the object created with that class is registered with an editor, using the editor's fe::IEditorFacade::addListener() method.

Note:

This class is declared with UC_DLL_INTERFACE_DECLARE

---

Member Function Documentation

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onCursorPosChanged	(	FeHandle *	sender,
		unsigned	byteIdx
	)			[pure virtual]

Invoked after cursor moved to another text position.

Parameters:

	sender	handle to an editor invoking the method
	byteIdx	new cursor position

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onTextInsert	(	FeHandle *	sender,
		unsigned	byteIdx,
		unsigned	lines,
		unsigned	bytes
	)			[pure virtual]

Invoked after some text was inserted.

Parameters:

	sender	handle to an editor invoking the method
	byteIdx	position at which text was inserted
	lines	number of text lines added to sender's text
	bytes	number of bytes added to sender's text

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onTextErase	(	FeHandle *	sender,
		unsigned	byteIdx,
		unsigned	lines,
		unsigned	bytes
	)			[pure virtual]

Invoked after some text was erased.

Parameters:

	sender	handle to an editor invoking the method
	byteIdx	position at which text was erased
	lines	number of text lines removed from sender's text
	bytes	number of bytes removed from sender's text

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onVisibleTextChanged	(	FeHandle *	sender,
		unsigned	lineIdx,
		unsigned	offset,
		unsigned	lines,
		unsigned	bytes
	)			[pure virtual]

Invoked after portion of text visible in the text viewport was changed.

Parameters:

	sender	handle to an editor invoking the method
	lineIdx	first visible text line
	offset	offset of the first visible byte relative to the first byte of the first visible line; if automatic text wrap if disabled this value is always 0
	lines	number of fully visible lines
	bytes	number of fully visible bytes

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onTextViewportChanged	(	FeHandle *	sender,
		unsigned	x,
		unsigned	y,
		unsigned	w,
		unsigned	h
	)			[pure virtual]

Invoked after text viewport rectangle changes.

Parameters:

	sender	handle to an editor invoking the method
	x	X coordinate of the text viewport top left corner relative to the top left corner of the sender's window rectangle
	y	Y coordinate of the text viewport top left corner relative to the top left corner of the sender's window rectangle
	w	new text viewport width
	h	new text viewport height

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onSharedOffscreenBufferAttached

(

FeHandle *

sender

)

[pure virtual]

Invoked after shared offscreen buffer was attached to the sender editor.

Note:

Use fe::IEditorFacade::getOffscreenGraphics() to access graphics context to draw on the offscreen buffer.

See also:

fe::IEditorFacade::isSharedOffscreenBufferAttached()

Parameters:

sender

handle to an editor invoking the method

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onSharedOffscreenBufferDetached

(

FeHandle *

sender

)

[pure virtual]

Invoked after shared offscreen buffer was detached from the sender editor.

See also:

fe::IEditorFacade::isSharedOffscreenBufferAttached()

Parameters:

sender

handle to an editor invoking the method

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onDecoratorFailed

(

FeHandle *

sender

)

[pure virtual]

Invoked when decorator installed with the sender editor reports an error.

See also:

fe::IEditorFacade::setDecorator()

fe::IDecorator

Parameters:

sender

handle to an editor invoking the method

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

virtual void UC_DLL_CALL fe::IEditorFacadeListener::onDestroyed

(

FeHandle *

sender

)

[pure virtual]

Invoked just before the sender editor is destroyed.

Parameters:

sender

handle to an editor invoking the method

Implemented in fe::EditorFacadeListenerProxy, and fe::EditorFacadeListenerStub.

---

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

• fe/ui/editor_facade_listener.h