WordGuise

The editable text field of the WordGuise class may contain text of multiple fonts, font sizes, styles, text encodings as well as pictures and can have the focus, similar to the EditField, Canvas or Listbox. The super class of this class is the WordGuiseContainer a control. A WordGuise instance can be instantiated on the fly by a variety of ways, without the need to put a template on the window first in design mode.

Technique 1:

dim wg as WordGuise
wg = new WordGuise
wg.left = 0
wg.top = 0
wg.width = 100
wg.height = 100
wg.embedWithin Window1

Technique 2:

dim wg as WordGuise
wg = new WordGuise
wg.embedWithin Window1, 0, 0, 100, 100

Technique 3:

dim wg as WordGuise
wg = new WordGuise(Window1, 0, 0, 100, 100

Technique 4:

In the RB-IDE drag a WordGuiseContainer on the window, set the super to WordGuise. RB will automatically embed it in the window, no need to call EmbedWithin.

Remark:

EmbedWithin can be used multiple times. Under the hood the plugin will take care of closing and reopening of the WordGuise widget.

WordGuiseContainer
WordGuise

class WordGuise implements

WordGuiseInterface

Properties

AcceptFocus	If true, the WordGuise can have the focus. It can accept the GotGocus and LostFocus events and can display a focus ring if UseFocusRing is set to true.
AcceptTabs	If true and AcceptFocus is true, then pressing tab triggers the keydown event for processing.
Active	If true WordGuise displays the blinking caret and active sliders.
Alignment	Sets or gets paragraph alignment for entire contents of the field. You can use four character strings or the Alignment constants defined in WordGuise Module.
AllCaps	Applies the capital characters to the contents of the field.
AllLowercase	Applies lowercase to all characters being typed in the field.
AutoDeactivate	Sets or gets the AutoDeactivate feature to WordGuise field.
AutoScroll	Gets or sets the ability of wordguise to auto scroll text.
BackColor	Sets or Gets the back color of the characters to be typed.
Backdrop	Sets or gets the backdrop picture of the field.
BackgroundColor	Sets or gets the background color of the widger
Bold	Applies the bold style to the text to be typed.
Border	Sets or unsets a drawn border around the widget. The default setting is false. If set to true, the BorderStyle property becomes effective.
BorderStyle	There are 3 choices when "Border" has been set: "Sunken" = 0 "Beveled" = 1 "Custom" = 2 Sunken means that we try to draw an OS specific border around the widget, Beveled means a Beveled style, and Custom means that we provide drawing space for those that don't like Sunken or Beveled. The space is 2 pixels wide and drawing should be done by using the graphics instance in the paint event.
BottomBorderStyle	Applies the bottom border style of the paragraph. Utilize a four character string or the border-style constants defined in WordGuise module.
Condensed	Applies the condensed style to the text to be typed.
DefaultTabWidth	Sets or gets the default tab width for the entire paragraph.
Direction	Sets or gets the direction of typing (left to right, or vice versa). Use a four character string or the Direction constants supplied in WordGuise Module to manipulate direction.
DontAutoEmbed	Gets or sets the value. This property is used to prevent RB from instantiating an instance of wordguise, if wordguise was put on the window in the IDE.
DragAndDrop	Used to let WordGuise do dragging. If set, make sure the dragflavor is set.
DragFlavor	A four character code, for example: "RTF ", "utxt".
EmbeddingWindow
Embossed	Sets or gets the embossed style at the current caret position.
Enabled	Sets or gets the enabled state of the WordGuise widget.
Engraved	Sets or gets the engraved style at the current caret position.
Extended	Sets or gets the extended style of text to be typed.
FirstLineIndent	Sets or gets the indentation of the first line of a paragraph.
FontID	The ATSUI font identifier set or get
FreezeUpdate
Graphics	Retrieves the graphics class of the WordGuise widget
HasBackgroundColor	Sets or gets the background state of the widget
HasGrowBoxCutOut	Used to indent the scrollbar to accommodate a windows grow box.
HasHScroll	Sets or gets the horizontal scrollbar visible state.
HasRuler	sets or gets the build-in ruler tied to WordGuise
HasToolbar
HasVScroll	Sets or gets the vertical scrollbar visible state.
Height	Sets or gets the height of the WordGuise widget.
HelpTag	Sets or gets the Help-tag text.
Hidden	Sets or gets the hidden state of characters to be typed.
HideSelection
HScrollIndent	Sets or gets the horizontal scrollbar left-indent. Useful if you want to use space left of the horizontal scrollbar.
IsStatic
IsUTF8
Italic	Sets or gets the italic style of text to be typed.
Kerning	It sets or gets the kerning factor on a character-level basis, where a factor of 0.0 means no kerning at all, 1.0 uses the kerning specified by the font designer, and any intermediate value between 0.0 and 1.0 uses a loosened kerning somewhere between no kerning and the default kerning. Of course, the kerning factor has no effect on fonts that don't have kerning tables.
Left
LeftIndent	Sets or gets the left text indentation of the paragraph.
LeftMargin	Sets or gets the left-Margin of the text-rendering area. This is useful to draw left of the text-rendering area. For example, you could use the graphics.drawstring method to draw line numbers, independent of the text-rendering engine.
Length	Gets the length of the text.
LiveHScroll
LiveVScroll
LockBottom	Sets or gets the Lock-Bottom state of the WordGuise widget.
LockLeft	Set or gets the Lock-Left state of the WordGuise widget.
LockRight	Sets or gets the Lock-Right state of the WordGuise widget.
LockTop	Sets or gets the Lock-Top state of WordGuise widget.
MarginBottom
MarginLeft
MarginRight
MarginTop
MouseX
MouseY
NoTabzoneWith	sets or gets the ruler distance from left and right text edges where tabs are disallowed.
NoTracking	Sets or gets the default tracking. It sets it only if condensed/tighten or expanded/loosen was set on the font.
Outline	Sets or gets the outline style of text to be typed.
PageHeight	Sets or gets the page height.
PageWidth	Sets or gets the page width.
PaneIndex	Gets or sets the pane (panel) index when the widget needs to live in a panel.
Plain	Sets or gets the plain style of text to be typed.
ReadOnly
RightIndent	Sets or gets the right indentation of the paragraph.
RulerDiscrete	sets or gets the indicator behavior of the ruler widgets to move in determined, discrete amounts.
RulerType	sets or gets the ruler unit measurement as inches, centimeters, points or picas.
SelAllCaps	Sets or gets the All-Caps style of selected text.
SelAllLowercase	Sets or gets the All-LowerCase style of selected text.
SelBackColor	Sets or gets the back color style of selected text.
SelBold	Sets or gets the bold style of selected text.
SelCondensed	Sets or gets the condensed style of selected text.
SelEmbossed	Sets or gets the embossed style of selected text.
SelEngraved	Sets or gets the engraved style of selected text.
SelExtended	Sets or gets the extended style of selected text.
SelFontID	The ATSUI font identifier set or get
SelHidden	Sets or gets the hidden style of selected text.
SelItalic	Sets or gets the italic style of selected text.
SelKerning	It sets or gets the kerning factor on a character-level basis, where a factor of 0.0 means no kerning at all, 1.0 uses the kerning specified by the font designer, and any intermediate value between 0.0 and 1.0 uses a loosened kerning somewhere between no kerning and the default kerning. Of course, the kerning factor has no effect on fonts that don't have kerning tables.
SelLength	Sets or gets the length of selected text.
SelNoTracking	Sets or gets the default tracking. It sets it only if condensed/tighten or expanded/loosen was set on the font.
SelOutline	Sets or gets the outline style of selected text.
SelPlain	Sets or gets the plain style of selected text.
SelShadow	Sets or gets the shadow style of selected text.
SelSmallCaps	Sets or gets the small caps style on selected text.
SelStart	Sets or gets the start position of selected text.
SelStrikethrough	Sets or gets the strikethrough style of selected text.
SelSubScript	Sets or gets the Subscript style of selected text.
SelSuperScript	Sets or gets the Superscript style of selected text.
SelText	Gets the selected text as string or inserts it.
SelTextColor	Sets or gets the text-color of selected text.
SelTextFont	Sets or gets the font of selected text.
SelTextSize	Sets or gets font size of selected text.
SelUnderline	Sets or gets the underline style of selected text.
SelUnderlineStyle	Sets or gets the underline styling of selected text.
SelUrlLink
Shadow	Sets or gets the shadow style of text to be typed.
SmallCaps	Sets or gets the small caps style at the current caret position.
SoftWrap	Sets or gets the soft wrapping feature.
SpaceAfter	Sets or gets the space after the paragraph.
SpaceBefore	Sets or gets the space before the paragraph.
Strikethrough	Sets or gets the strikethrough style of text to be typed.
SubScript	Sets or gets the subscript style at the current caret position.
SuperScript	Sets or gets the superscript style at the current caret position.
TabIndex
TabStop
Text	Gets or sets the total text present in WordGuise widget.
TextColor	Sets or gets the text-color of text to be typed.
TextFont	Gets or sets the text font of text to be typed.
TextMargin	Gets or sets the text-margin of the WordGuise widget. The margin applies to the left, right, top and bottom of the text-rendering area.
TextSize	Gets or sets the font size style of text to be typed.
Top
Transparent	Sets or Gets the (semi) transparent state.
TrueWindow	Returns the "true" window the widget lives in.
Underline	Gets or sets the underline style of text to be typed.
UnderlineStyle	Sets or gets the underline style at the current caret position.
UrlLink
UseFocusRing	Gets or sets the UseFocusRing state of the WordGuise widget.
VerticalShift	Gets or sets the vertical displacement of text lines.
Visible	Sets or gets the visible state of WordGuise widget.
VScrollIndent	Sets or gets the vertical scroll indentation at the top of the bar. Useful to add something else on the top of the vertical scrollbar.
Width	Sets or gets the width of WordGuise widget.

Methods

AcceptDataDrop
AcceptFileDrop
AcceptPictureDrop
AcceptTextDrop
AcceptWGDrops	Private way for the widget to accept drops of a particular flavor
Activate
AddMenuHandler	Method to be used with user-defined menuItem handlers. The syntax here is: AddMenuHandler EditCut, AddressOf myEditCutHandler
AddMenuHandler	Method to be used together with the WordGuiseInterface to add WordGuise owned MenuItem handlers.
AlignmentMenuItems
BackColorMenuItems
BeginUndo
BorderStyleMenuItems
CanPaste	tells whether stuff on the scrap/clipboard can be pasted into WordGuise.
CanRedo	tells whether a previously undo command can be reversed.
CanUndo
ChangeCase	Changes upper or lower case of selected text.
Char	Gets the keyCode of the char at charPosition.
CharPosAtXY	Returns the character position at the controls x,y coordinates.
CharPosAtXY	Returns the character position at the controls x,y coordinates.
CharPosToXY	Converts the char position to x,y coordinates.
CharPosToXY	Converts the char position to x,y coordinates.
Clear	Clears the selected text.
ClearUndo	Clears the list of actions the Undo engine had stored.
Close	Used when you want to close a WordGuise widget and still want to retain the instance and its settings.
Constructor
Constructor	This is a default constructor that REALbasic will call when an instance of this class, WordGuise, is created in the RB-IDE. You do this by dragging the WordGuiseContainer from the "Plugin Controls" palette onto Window1 located in the design frame panel. Note that "WordGuiseContainer Control" is the base class to WordGuise, and therefore you will need to set the super of "WordGuiseContainer1" to "WordGuise". You do this by navigating in the "Property Pane" of REALbasic and make the adjustment. An alternative way is to right-clicked (control-clicked) on a window or a tabpanel.
Constructor
Copy
CopyToScrap
Cut	cuts the selected text to the scrap/clipboard
DestinationHeight	returns the total height of the current text
DestinationWidth	returns the destination width (current page width)
DirectionMenuItems
EmbedWithin
EmbedWithin
EmbedWithinPanel
EndUndo
Feature	Gets the WordGuiseFeature class instance, associated with WordGuise. Each WordGuise instance has a valid feature object to manage the behavior of text rendering at runtime.
Find	will find the indicated search string in the text.
FindNextObject	Finds the nearest object from the offset supplied.
FindPreviousObject	finds the nearest object upstream of the offset supplied.
Focus	Alternative way to set focus (or remove focus)
FontMenuItems
FromClipboard
GetObject	Obtains the array-based object.
GetObjectCount	Gets the total number of objects living in the widget,
GetSelection	returns the selection of text in the selStart and selEnd fields of the method
Hide	Hides the widget
IndentationMenuItems
InsertObject	Inserts a picture at the current cursor position and returns a newly created WordGuiseObject
IsTyping
LanguageMenuItems
LineNumAtCharPos	Returns the line number at char position.
LinePosAtXY	returns an instance of wordGuiseLine when interrogating the line position at x,y coordinates.
LineRangeAtIndex
LineSpacing	Sets or gets the line-spacing of a paragraph.
Modified
NewDragItem	Creates a new dragItem containing selected text
ObjectAtOffset	Returns an object when present at the offset in the text.
OleInsert	A windows only feature that will allow launching of applications when the object is double clicked
Operator_Convert
PanelChange	same as panelchange
ParagraphNumAtCharPos	Returns the paragraph number at charPosition.
ParagraphPosAtXY	Gets the paragraph position at x,y coordinate. The function returns a WordGuiseParagraph instance.
Paste
PasteFromScrap
PinScroll
PrintSession
ReCalText	Recalculates text drawing
ReDraw
Redo	Reverses a previous undo action.
ReFresh	Shadowed method, will work in RB 2k, but not in RB5.5.5. Alternative is ReDraw
RefreshRuler	Forces the redrawing of the ruler and its widgets.
RegisterCustomTagItem
ResetModified
Resize	Resize is a method to be utilized in the windows resizing and resized events when WordGuise was instantiated.
Scroll	Allows the scrolling of WordGuise in the horizontal and/or vertical dimensions.
ScrollRead
ScrollToSelelection
ScrollWrite
SelectAll	selects the text in WordGuise.
SelectedObject	If an Object (Picture) is selected it will return a new instance of WordGuiseObject.
SelectionAnchor
SelectNone
SetFocus	A shadowed method. will work in RB 2k5, but not in RB 5.5.5. In the latter case use: focus = true
SetSelection	sets the selection of text using the selTart and selEnd boundaries
Show	Shows the widget
SizeMenuItems
Style	Gets or sets the WordGuiseStyledText instance to utilize specific methods that also include the methods and properties defined in WordGuise.
StyleMenuItems
StyleRunNumAtCharPos	Returns the StyleRun index at the char position in the text.
Tab	Gets or sets the WordGuiseTabItem property.
Table
TabPanelChange	Method to be used in the TabPanelChange event handler when a WordGuise widget is created in code and lives on a tabpanel.
TextColorMenuItems
ToClipboard
TransferModeMenuItems
UnderlineStyleMenuItems
Undo	Undoes the current user action.
UndoInfo	Provides the current Undo Info by returning a value, corresponding to Undo constants defined in WordGuise module.
UndoInfo
UndoMessage	Provides the Undo Info as an Undo message.
ViewHeight	returns the view height (rendering height)
ViewWidth	returns the view width (rendering width)
Window
WordPosAtXY	Returns the Word position at the x-y coordinates.
_Index
_SetIndex
_SetWindow
iCopy (Inherited)
iCut (Inherited)
iDelete (Inherited)
iOpen (Inherited)
iPaste (Inherited)
iRedo (Inherited)
iSave (Inherited)
iSaveAs (Inherited)
iSelectAll (Inherited)
iSelectNone (Inherited)
iUndo (Inherited)

Events

Close	Fired when the WordGuise widget closes.
ConstructContextualMenu
ContentSizeChange
ContextualMenuAction
DragEnter
DragExit
DragOver
DropObject
EnableMenuItems
GotFocus	Called when the class has obtained the keyboard focus.
KeyDown	Called when a key was pressed.
KeyUp
LostFocus	Called when the class looses the keyboard focus.
MouseDown	called when the mouse was clicked. mousemoved is additional functionality one can use to detect the start of a drag.
MouseDownObject
MouseDrag	Mouse button was pressed inside the WordGuise region and moved (dragged) at the x,y location. This event occurs when the previous mouse down was handled by returning true.
MouseEnter
MouseEnterObject
MouseExit
MouseHoverObject
MouseLeaveObject
MouseMove
MouseUp	The mouse was released inside the WordGuise region at the x,y position.
MouseWheel
Moved
Open	This event is fired when the WordGuise widget has been instantiated successfully. This event can be used to provide further initializing properties to be set.
Paint
PanelChange
Resized
Resizing
RulerChange
ScrollChange
SelChange
StyleChange
TextChange
Undo
UrlLink
WordBreak	This event will be fired when FindWord or a double click is issued. When you implement this event, it'll provide a custom Word-Break hook, so you could conceivably implement RegEx here to allow a word like "WordGuise_Monster" to be recognized as one word and not be seen as two separate words. In order to get this to work you will need to instantiate a WordGuiseWord class containing the start and end offsets.

Supported Platforms:

PPC - MacOS 9

Carbon - MacOS X (PEF)

MacOS X PPC - (Mach-O)

MacOS X Universal Binary (Mach-O)

Win32 - Windows

Unsupported Platforms:

Linux x86

WordGuise Class

Properties

Methods

Events

Supported Platforms:

Unsupported Platforms: