0b9d53db-9fdd-4234-8eb8-871c6c604201 312 4 5 decimal

&[DATE] &[TIME] - &[FILENAME]

Writer Manager

[β version]

by Davide Carpi (davide.carpi@gmail.com)

]]>

OVERVIEW

Writer Manager is the core of the Writer Region plugin. It contains the base region (WriterArea) and the resources

to handle it.

WriterArea contains a list of base-elements (Glyphs) grouped in Paragraphs (groups of glyphs separated by linefeeds) and Lines (what is shown in the canvas as a line).

]]>

To use one or more WriterArea(s) in your project:

1) copy the WriterManager folder from the WriterRegion sources and include it in you project;

2) Reference the namespace:

using WriterManager;

3) in your RegionBase/RegionEvaluable class, add all the WriterArea you need;

4) handle them as shown in the WriterRegion.

note: WriterArea doesn't handle directly the history and languages, that should be driven through your RegionBase.

]]>

RegionBase methods surrounded by WriterArea:

- OnPaint(PaintEventArgs e)

paint the area

- OnCommandSend(string value)

allow inputs from keyboard

- OnKeyDown(KeyEventArgs e)

allow inputs from keyboard

- OnMouseDown(MouseEventArgs e)

allow inputs from mouse

- OnMouseUp(MouseEventArgs e)

allow inputs from mouse

- OnMouseMove(MouseEventArgs e)

allow inputs from mouse

- GetCursorType(MouseEventArgs point)

change the cursor icon

- Copy(IClipboardManager clipboard)

allow data sharing from the clipboard

- GetSelectionStatus()

enable cut/copy/delete context menu items

- Paste(IClipboardManager clipboard)

allow data sharing from the clipboard

- FromXml(XmlTextReader reader, FileParsingContext parsingContext)

get xml data

- ToXml(XmlTextWriter writer, FileParsingContext parsingContext)

set xml data

- IsEmpty()

check if the area is empty

]]>

WriterArea bonus fields:

- Multiline

if false, multiline text is not allowed (from the clipboard you can get the first line of the text)

- ReadOnly

if true, text input is disabled; select and copy are allowed

- EnableOuterClicks

if true, clicks on the RegionBase canvas outside the WriterArea's bounds are allowed (you have to set it to false if you want to use multiple WriterAreas on your RegionBase)

- DisabledStyles

here you can set all the styles that you won't be available for the user. This affects also the toolstrip and the data pasted from the clipboard

- RotateFlip

the rotation/flip of the text when it is not focused

- BackColor

WriterArea's background color

]]>

BEHIND THE SCENES

The base object of this region is called Glyph and is thinked as any object that can be selected by the user. Each glyph could be a character, a set of characters or an object.

Data is shared through WriterAreas using HTML code (WriterData). Because the HTML decoding is designed to support just the WriterData output syntax (and not the whole HTML syntax) if you plan to extend the WriterArea code of your region with more glyphs or features, sharing data via clipboard you may cause issues on third-party regions; therefore it is reccomended to share your improvements with the community to extend the code to support everywhere the changes.

Alternatively you can plan to add another layer of data in the clipboard handling of you plugin providing yourself the compatibility rules (a compatible "SMath.WriterData", DataFormats.UnicodeText, DataFormats.Text and your own format).

]]>