GuiDocumentViewer.h

/*********************************************************************** Vczh Library++ 3.0 Developer: Zihan Chen(vczh) GacUI::Control System Interfaces: ***********************************************************************/

#ifndef VCZH_PRESENTATION_CONTROLS_GUIDOCUMENTVIEWER

#define VCZH_PRESENTATION_CONTROLS_GUIDOCUMENTVIEWER

#include "../GuiContainerControls.h"

#include "EditorCallback/GuiTextUndoRedo.h"

namespace

{

namespace

presentation

{

namespace

compositions

{

class

GuiShortcutKeyManager

; }

namespace

controls

{

/*********************************************************************** GuiDocumentCommonInterface ***********************************************************************/

class

GuiDocumentCommonInterface

;

/// <summary>Embedded object in a document.</summary>

class

GuiDocumentItem

public

Object

public

Description

GuiDocumentItem

> {

friend

class

GuiDocumentCommonInterface

;

protected

bool

visible

false

;

WString

name

;

compositions

GuiBoundsComposition

container

;

bool

owned

false

;

public

GuiDocumentItem

(

const

WString

_name

);

GuiDocumentItem

();

/// <summary>Get the container for all embedded controls and compositions in this item.</summary>

/// <returns>The container.</returns>

compositions

GuiGraphicsComposition

GetContainer

();

/// <summary>Get the name of the document item.</summary>

/// <returns>The name.</returns>

WString

GetName

(); };

/// <summary>Document displayer control common interface for displaying <see cref="DocumentModel"/>.</summary>

class

GuiDocumentCommonInterface

abstract

protected

virtual

elements

GuiDocumentElement

ICallback

public

Description

GuiDocumentCommonInterface

> {

typedef

collections

Dictionary

WString

Ptr

GuiDocumentItem

DocumentItemMap

;

public

/// <summary>Represents the edit mode.</summary>

enum

EditMode

{

/// <summary>View the rich text only.</summary>

ViewOnly

/// <summary>The rich text is selectable.</summary>

Selectable

/// <summary>The rich text is editable.</summary>

Editable

, };

protected

Ptr

DocumentModel

baselineDocument

;

DocumentItemMap

documentItems

;

GuiControl

documentControl

nullptr

;

elements

GuiDocumentElement

documentElement

nullptr

;

compositions

GuiBoundsComposition

documentComposition

nullptr

;

compositions

GuiGraphicsComposition

documentMouseArea

nullptr

;

Ptr

compositions

IGuiGraphicsEventHandler

onMouseMoveHandler

;

Ptr

compositions

IGuiGraphicsEventHandler

onMouseDownHandler

;

Ptr

compositions

IGuiGraphicsEventHandler

onMouseUpHandler

;

Ptr

compositions

IGuiGraphicsEventHandler

onMouseLeaveHandler

;

Ptr

DocumentHyperlinkRun

Package

activeHyperlinks

;

bool

dragging

false

;

EditMode

editMode

EditMode

ViewOnly

;

Ptr

GuiDocumentUndoRedoProcessor

undoRedoProcessor

;

Ptr

compositions

GuiShortcutKeyManager

internalShortcutKeyManager

;

protected

void

InvokeUndoRedoChanged

();

void

InvokeModifiedChanged

();

void

UpdateCaretPoint

();

void

EnsureDocumentRectVisible

(

Rect

bounds

);

void

Move

(

TextPos

caret

bool

shift

bool

frontSide

);

bool

ProcessKey

(

VKEY

code

bool

shift

bool

ctrl

);

void

InstallDocumentViewer

(

GuiControl

_sender

compositions

GuiGraphicsComposition

_mouseArea

compositions

GuiGraphicsComposition

_container

compositions

GuiGraphicsComposition

eventComposition

compositions

GuiGraphicsComposition

focusableComposition

);

void

ReplaceMouseArea

(

compositions

GuiGraphicsComposition

_mouseArea

);

void

SetActiveHyperlink

(

Ptr

DocumentHyperlinkRun

Package

package

);

void

ActivateActiveHyperlink

(

bool

activate

);

void

AddShortcutCommand

(

VKEY

key

const

Func

void

()>&

eventHandler

);

void

EditTextInternal

(

TextPos

begin

TextPos

end

const

Func

void

(

TextPos

vint

&)>&

editor

);

void

EditStyleInternal

(

TextPos

begin

TextPos

end

const

Func

void

(

TextPos

)>&

editor

);

void

MergeBaselineAndDefaultFont

(

Ptr

DocumentModel

document

);

void

OnFontChanged

();

void

OnCaretNotify

(

compositions

GuiGraphicsComposition

sender

compositions

GuiEventArgs

arguments

);

void

OnGotFocus

(

compositions

GuiGraphicsComposition

sender

compositions

GuiEventArgs

arguments

);

void

OnLostFocus

(

compositions

GuiGraphicsComposition

sender

compositions

GuiEventArgs

arguments

);

void

OnKeyDown

(

compositions

GuiGraphicsComposition

sender

compositions

GuiKeyEventArgs

arguments

);

void

OnCharInput

(

compositions

GuiGraphicsComposition

sender

compositions

GuiCharEventArgs

arguments

);

void

UpdateCursor

(

INativeCursor

cursor

);

Point

GetMouseOffset

();

void

OnMouseMove

(

compositions

GuiGraphicsComposition

sender

compositions

GuiMouseEventArgs

arguments

);

void

OnMouseDown

(

compositions

GuiGraphicsComposition

sender

compositions

GuiMouseEventArgs

arguments

);

void

OnMouseUp

(

compositions

GuiGraphicsComposition

sender

compositions

GuiMouseEventArgs

arguments

);

void

OnMouseLeave

(

compositions

GuiGraphicsComposition

sender

compositions

GuiEventArgs

arguments

);

virtual

Point

GetDocumentViewPosition

();

virtual

void

EnsureRectVisible

(

Rect

bounds

);

//================ callback

void

OnStartRender

()

override

;

void

OnFinishRender

()

override

;

Size

OnRenderEmbeddedObject

(

const

WString

name

const

Rect

location

)

override

;

public

GuiDocumentCommonInterface

();

GuiDocumentCommonInterface

();

/// <summary>Active hyperlink changed event.</summary>

compositions

GuiNotifyEvent

ActiveHyperlinkChanged

;

/// <summary>Active hyperlink executed event.</summary>

compositions

GuiNotifyEvent

ActiveHyperlinkExecuted

;

/// <summary>Selection changed event.</summary>

compositions

GuiNotifyEvent

SelectionChanged

;

/// <summary>Undo redo status changed event.</summary>

compositions

GuiNotifyEvent

UndoRedoChanged

;

/// <summary>Modified status changed event.</summary>

compositions

GuiNotifyEvent

ModifiedChanged

;

/// <summary>Get the document.</summary>

/// <returns>The document.</returns>

Ptr

DocumentModel

GetDocument

();

/// <summary>Set the document. When a document is set to this element, modifying the document without invoking <see cref="NotifyParagraphUpdated"/> will lead to undefined behavior.</summary>

/// <param name="value">The document.</param>

void

SetDocument

(

Ptr

DocumentModel

value

);

//================ document items

/// <summary>Add a document item. The name of the document item will display in the position of the <object> element with the same name in the document.</summary>

/// <param name="value">The document item.</param>

/// <returns>Returns true if this operation succeeded.</returns>

bool

AddDocumentItem

(

Ptr

GuiDocumentItem

value

);

/// <summary>Remove a document item.</summary>

/// <param name="value">The document item.</param>

/// <returns>Returns true if this operation succeeded.</returns>

bool

RemoveDocumentItem

(

Ptr

GuiDocumentItem

value

);

/// <summary>Get all document items.</summary>

/// <returns>All document items.</returns>

const

DocumentItemMap

GetDocumentItems

();

//================ caret operations

/// <summary>

/// Get the begin position of the selection area.

/// </summary>

/// <returns>The begin position of the selection area.</returns>

TextPos

GetCaretBegin

();

/// <summary>

/// Get the end position of the selection area.

/// </summary>

/// <returns>The end position of the selection area.</returns>

TextPos

GetCaretEnd

();

/// <summary>

/// Set the end position of the selection area.

/// </summary>

/// <param name="begin">The begin position of the selection area.</param>

/// <param name="end">The end position of the selection area.</param>

void

SetCaret

(

TextPos

begin

TextPos

end

);

/// <summary>Calculate a caret using a specified point.</summary>

/// <returns>The calculated caret.</returns>

/// <param name="point">The specified point.</param>

TextPos

CalculateCaretFromPoint

(

Point

point

);

/// <summary>Get the bounds of a caret.</summary>

/// <returns>The bounds.</returns>

/// <param name="caret">The caret.</param>

/// <param name="frontSide">Set to true to get the bounds for the character before it.</param>

Rect

GetCaretBounds

(

TextPos

caret

bool

frontSide

);

//================ editing operations

/// <summary>Notify that some paragraphs are updated.</summary>

/// <param name="index">The start paragraph index.</param>

/// <param name="oldCount">The number of paragraphs to be updated.</param>

/// <param name="newCount">The number of updated paragraphs.</param>

/// <param name="updatedText">Set to true to notify that the text is updated.</param>

void

NotifyParagraphUpdated

(

vint

index

vint

oldCount

vint

newCount

bool

updatedText

);

/// <summary>Edit run in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="model">The new run.</param>

/// <param name="copy">Set to true to copy the model before editing. Otherwise, objects inside the model will be used directly</param>

void

EditRun

(

TextPos

begin

TextPos

end

Ptr

DocumentModel

model

bool

copy

);

/// <summary>Edit text in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="frontSide">Set to true to use the text style in front of the specified range.</param>

/// <param name="text">The new text.</param>

void

EditText

(

TextPos

begin

TextPos

end

bool

frontSide

const

collections

Array

WString

text

);

/// <summary>Edit style in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="style">The new style.</param>

void

EditStyle

(

TextPos

begin

TextPos

end

Ptr

DocumentStyleProperties

style

);

/// <summary>Edit image in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="image">The new image.</param>

void

EditImage

(

TextPos

begin

TextPos

end

Ptr

GuiImageData

image

);

/// <summary>Set hyperlink in a specified range.</summary>

/// <param name="paragraphIndex">The index of the paragraph to edit.</param>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="reference">The reference of the hyperlink.</param>

/// <param name="normalStyleName">The normal style name of the hyperlink.</param>

/// <param name="activeStyleName">The active style name of the hyperlink.</param>

void

EditHyperlink

(

vint

paragraphIndex

vint

begin

vint

end

const

WString

reference

const

WString

normalStyleName

DocumentModel

NormalLinkStyleName

const

WString

activeStyleName

DocumentModel

ActiveLinkStyleName

);

/// <summary>Remove hyperlink in a specified range.</summary>

/// <param name="paragraphIndex">The index of the paragraph to edit.</param>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

void

RemoveHyperlink

(

vint

paragraphIndex

vint

begin

vint

end

);

/// <summary>Edit style name in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="styleName">The new style name.</param>

void

EditStyleName

(

TextPos

begin

TextPos

end

const

WString

styleName

);

/// <summary>Remove style name in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

void

RemoveStyleName

(

TextPos

begin

TextPos

end

);

/// <summary>Rename a style.</summary>

/// <param name="oldStyleName">The name of the style.</param>

/// <param name="newStyleName">The new name.</param>

void

RenameStyle

(

const

WString

oldStyleName

const

WString

newStyleName

);

/// <summary>Clear all styles in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

void

ClearStyle

(

TextPos

begin

TextPos

end

);

/// <summary>Summarize the text style in a specified range.</summary>

/// <returns>The text style summary.</returns>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

Ptr

DocumentStyleProperties

SummarizeStyle

(

TextPos

begin

TextPos

end

);

/// <summary>Summarize the style name in a specified range.</summary>

/// <returns>The style name summary.</returns>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

Nullable

WString

SummarizeStyleName

(

TextPos

begin

TextPos

end

);

/// <summary>Set the alignment of paragraphs in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="alignments">The alignment for each paragraph.</param>

void

SetParagraphAlignments

(

TextPos

begin

TextPos

end

const

collections

Array

Nullable

Alignment

>>&

alignments

);

/// <summary>Set the alignment of paragraphs in a specified range.</summary>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

/// <param name="alignment">The alignment for each paragraph.</param>

void

SetParagraphAlignment

(

TextPos

begin

TextPos

end

Nullable

Alignment

alignment

);

/// <summary>Summarize the text alignment in a specified range.</summary>

/// <returns>The text alignment summary.</returns>

/// <param name="begin">The begin position of the range.</param>

/// <param name="end">The end position of the range.</param>

Nullable

Alignment

SummarizeParagraphAlignment

(

TextPos

begin

TextPos

end

);

//================ editing control

/// <summary>Get the href attribute of the active hyperlink.</summary>

/// <returns>The href attribute of the active hyperlink.</returns>

WString

GetActiveHyperlinkReference

();

/// <summary>Get the edit mode of this control.</summary>

/// <returns>The edit mode.</returns>

EditMode

GetEditMode

();

/// <summary>Set the edit mode of this control.</summary>

/// <param name="value">The edit mode.</param>

void

SetEditMode

(

EditMode

value

);

//================ selection operations

/// <summary>Select all text.</summary>

void

SelectAll

();

/// <summary>Get the selected text.</summary>

/// <returns>The selected text.</returns>

WString

GetSelectionText

();

/// <summary>Set the selected text.</summary>

/// <param name="value">The selected text.</param>

void

SetSelectionText

(

const

WString

value

);

/// <summary>Get the selected model.</summary>

/// <returns>The selected model.</returns>

Ptr

DocumentModel

GetSelectionModel

();

/// <summary>Set the selected model.</summary>

/// <param name="value">The selected model.</param>

void

SetSelectionModel

(

Ptr

DocumentModel

value

);

//================ clipboard operations

/// <summary>Test can the selection be cut.</summary>

/// <returns>Returns true if the selection can be cut.</returns>

bool

CanCut

();

/// <summary>Test can the selection be copied.</summary>

/// <returns>Returns true if the selection can be cut.</returns>

bool

CanCopy

();

/// <summary>Test can the content in the clipboard be pasted.</summary>

/// <returns>Returns true if the content in the clipboard can be pasted.</returns>

bool

CanPaste

();

/// <summary>Cut the selection text.</summary>

/// <returns>Returns true if this operation succeeded.</returns>

bool

Cut

();

/// <summary>Copy the selection text.</summary>

/// <returns>Returns true if this operation succeeded.</returns>

bool

Copy

();

/// <summary>Paste the content from the clipboard and replace the selected text.</summary>

/// <returns>Returns true if this operation succeeded.</returns>

bool

Paste

();

//================ undo redo control

/// <summary>Test can undo.</summary>

/// <returns>Returns true if this action can be performed.</returns>

bool

CanUndo

();

/// <summary>Test can redo.</summary>

/// <returns>Returns true if this action can be performed.</returns>

bool

CanRedo

();

/// <summary>Clear all undo and redo information.</summary>

void

ClearUndoRedo

();

/// <summary>Test is the text box modified.</summary>

/// <returns>Returns true if the text box is modified.</returns>

bool

GetModified

();

/// <summary>Notify the text box that the current status is considered saved.</summary>

void

NotifyModificationSaved

();

/// <summary>Perform the undo action.</summary>

/// <returns>Returns true if this operation succeeded.</returns>

bool

Undo

();

/// <summary>Perform the redo action.</summary>

/// <returns>Returns true if this operation succeeded.</returns>

bool

Redo

(); };

/*********************************************************************** GuiDocumentViewer ***********************************************************************/

/// <summary>Scrollable document viewer for displaying <see cref="DocumentModel"/>.</summary>

class

GuiDocumentViewer

public

GuiScrollContainer

public

GuiDocumentCommonInterface

public

Description

GuiDocumentViewer

> {

GUI_SPECIFY_CONTROL_TEMPLATE_TYPE(DocumentViewerTemplate, GuiScrollContainer)

public

using

ControlTemplateType

templates

GuiDocumentViewerTemplate

;

private

templates

GuiDocumentViewerTemplate

controlTemplateObject370

nullptr

;

void

BeforeControlTemplateUninstalled_

();

void

AfterControlTemplateInstalled_

(

bool

initialize

);

protected

void

BeforeControlTemplateUninstalled

()

override

{

BeforeControlTemplateUninstalled_

();

GuiScrollContainer

BeforeControlTemplateUninstalled

(); }

void

AfterControlTemplateInstalled

(

bool

initialize

)

override

{

GuiScrollContainer

AfterControlTemplateInstalled

(

initialize

);

AfterControlTemplateInstalled_

(

initialize

); }

void

CheckAndStoreControlTemplate

(

templates

GuiControlTemplate

value

)

override

{

auto

dynamic_cast

templates

GuiDocumentViewerTemplate

*>(

value

);

{

(!(

))

throw

Error

(

L"The assigned control template is not vl::presentation::templates::Gui"

L"DocumentViewerTemplate"

L"."

);}

while

(

);

controlTemplateObject370

;

GuiScrollContainer

CheckAndStoreControlTemplate

(

value

); }

public

templates

GuiDocumentViewerTemplate

TypedControlTemplateObject

(

bool

ensureExists

) {

(

ensureExists

) {

EnsureControlTemplateExists

(); }

return

controlTemplateObject370

; }

private

protected

void

UpdateDisplayFont

()

override

;

Point

GetDocumentViewPosition

()

override

;

void

EnsureRectVisible

(

Rect

bounds

)

override

;

public

/// <summary>Create a control with a specified style provider.</summary>

/// <param name="themeName">The theme name for retriving a default control template.</param>

GuiDocumentViewer

(

theme

ThemeName

themeName

);

GuiDocumentViewer

();

const

WString

GetText

()

override

;

void

SetText

(

const

WString

value

)

override

; };

/*********************************************************************** GuiDocumentViewer ***********************************************************************/

/// <summary>Static document viewer for displaying <see cref="DocumentModel"/>.</summary>

class

GuiDocumentLabel

public

GuiControl

public

GuiDocumentCommonInterface

public

Description

GuiDocumentLabel

> {

GUI_SPECIFY_CONTROL_TEMPLATE_TYPE(DocumentLabelTemplate, GuiControl)

public

using

ControlTemplateType

templates

GuiDocumentLabelTemplate

;

private

templates

GuiDocumentLabelTemplate

controlTemplateObject393

nullptr

;

void

BeforeControlTemplateUninstalled_

();

void

AfterControlTemplateInstalled_

(

bool

initialize

);

protected

void

BeforeControlTemplateUninstalled

()

override

{

BeforeControlTemplateUninstalled_

();

GuiControl

BeforeControlTemplateUninstalled

(); }

void

AfterControlTemplateInstalled

(

bool

initialize

)

override

{

GuiControl

AfterControlTemplateInstalled

(

initialize

);

AfterControlTemplateInstalled_

(

initialize

); }

void

CheckAndStoreControlTemplate

(

templates

GuiControlTemplate

value

)

override

{

auto

dynamic_cast

templates

GuiDocumentLabelTemplate

*>(

value

);

{

(!(

))

throw

Error

(

L"The assigned control template is not vl::presentation::templates::Gui"

L"DocumentLabelTemplate"

L"."

);}

while

(

);

controlTemplateObject393

;

GuiControl

CheckAndStoreControlTemplate

(

value

); }

public

templates

GuiDocumentLabelTemplate

TypedControlTemplateObject

(

bool

ensureExists

) {

(

ensureExists

) {

EnsureControlTemplateExists

(); }

return

controlTemplateObject393

; }

private

protected

void

UpdateDisplayFont

()

override

;

public

/// <summary>Create a control with a specified default theme.</summary>

/// <param name="themeName">The theme name for retriving a default control template.</param>

GuiDocumentLabel

(

theme

ThemeName

themeName

);

GuiDocumentLabel

();

const

WString

GetText

()

override

;

void

SetText

(

const

WString

value

)

override

; }; } } }

#endif