Packages‎ > ‎

gnocl::abiwidget

A widget which displays a full-featured word-processing editing canvas.

Note: This documentation is in the process of being compiled. Those areas whose contents may not be an accurate description are marked with (revise)

Synopsis

gnocl::abiwidget [-option value...]

Screenshot




Options

-onBold string  (default: "")

Tcl script which is executed to reflect the effects of the emboldening on the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onItalic string  (default: "")

Tcl script which is executed to reflect the effects of  italicization on the character  containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onUnderline string  (default: "")

Tcl script which is executed to reflect the effects of underlining on the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onOverline string  (default: "")

Tcl script which is executed to reflect the effects of overlining on the characte containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onLineThrough string  (default: "")

Tcl script which is executed to reflect the effects of any linethrough formatting on the character/selection containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onTopline string  (default: "")

Tcl script which is executed to reflect the effects of any topline formatting on the character  containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onBottomline string  (default: "")

Tcl script which is executed to reflect the effects of any bottomline formatting on the character/selection containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onSuperscript string  (default: "")

Tcl script which is executed to reflect the effects of any superscript formatting on the character/selection containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onSubscript string  (default: "")

Tcl script which is executed to reflect the effects of any subscript formatting on the character/selection containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onCanUndo string  (default: "")

Tcl script which is executed to reflect the effects of the previous edits can be undone. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onCanRedo string  (default: "")

Tcl script which is executed to reflect the effects of the previous edits can be redone. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onIsDirty string  (default: "") (revise)

Tcl script which is executed to reflect ??????????????. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onLeftAlign string  (default: "")

Tcl script which is executed to reflect the effects of any left-align formatting on the character/selection containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onCenterAlign string  (default: "")

Tcl script which is executed to reflect the effects of any center-align formatting on the character/selection containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onRightAlign string  (default: "")

Tcl script which is executed to reflect the effects of any right-align formatting on the character/selection containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onJustifyAlign string  (default: "")

Tcl script which is executed to reflect the effects justification on the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onTextSelected string  (default: "") (revise)

Tcl script which is executed to reflect the effects of select operation on the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onImageSelected string  (default: "")  (revise)

Tcl script which is executed to reflect the effects of select operation on images contained in the edit canvas. Before evaluation the following percent strings are substituted:

%w  widget name
%v
   boolean

-onSelectionCleared string  (default: "")  (revise)

Tcl script which is executed to reflect the effects of selection-cleared operation on images contained in the edit canvas. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onEnterSelection string  (default: "") (revise)

Tcl script which is executed to reflect the effects of selection-entered operation on images contained in the edit canvas. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onLeaveSelection string  (default: "") (revise)

Tcl script which is executed to reflect the effects of leave-selection operation on images contained in the edit canvas. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onTableState  string  (default: "")  (revise)

Tcl script which is executed to reflect the effects of tables-state  operation on tables contained in the edit canvas. Before evaluation the following percent strings are substituted:

%w  widget name
%v   boolean

-onColor string  (default: "")

Tcl script which is executed to reflect the text-color applied  on the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   color  (three RGB decimal integers in the range 0-255)

-onChanged string  (default: "")

Tcl script which is executed to indicate the change state of the canvas buffer.  Before evaluation the following percent strings are substituted:

%w  widget name
 
-onFontSize string  (default: "") (revise)

Tcl script which is executed to reflect the font-size of the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v    float (decimal size in ???)

-onFontFamily


Tcl script which is executed to reflect the font-family applied  on the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   string 

-onStyleName

Tcl script which is executed to reflect the style applied  on the character containing the current cursor position. Before evaluation the following percent strings are substituted:

%w  widget name
%v   the active font style

-onPageCount

Tcl script which is executed when the total number of pages in the active document changes. Before evaluation the following percent strings are substituted:

%w  widget name
%v   the total number of pages

-onCurrentPage

Tcl script which is executed when the current  page  in the active document changes. Before evaluation the following percent strings are substituted:

%w  widget name
%v   current page number

-onZoom

Tcl script which is executed when the zoom factor  in the active document changes. Before evaluation the following percent strings are substituted:

%w  widget name
%v   zoom factor as percentage of original size

Description


Offset Keywords

A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 


bob  
bod  
bow  
eob  
eod  
eol  
eow  
left  
right  
nextLine  
nextPage  
nextScreen
 
prevLine
 
nextLine  
nextScreen
 

Note:

In order to reflect the content of the Abiwidget API, the list of offset names should be regarded as different to those specified in the gnocl::text and gnocl::sourceview documentation. These differences are historical in nature and maintained for to prevent confusion when referencing the Abiwidget Gtk+ specification or the Abiword source code.

Commands

id load filespec

Clear the contents of the current edit canvas and load the filespec which is the full file URI. During loading, the file format will be detected and loaded if supported. The range of loadable file formats and their extensions include:

Abiword  .abw .awt .zabw
Microsoft Word
 .dox .dot
Rich Text Format
 .rtf
Text  .txt .text
HMTL  .html .htm .xhtml
Collaborative Files Descriptor
 .abicollab
XSL-FO
 .fo
Clarisworks/Appleworks 5
 .cwk

Returns 1 if the filespec is successfully loaded, other wise 0.
id save filespec
Save the contents of the current edit canvas to filespec which is the full file URI. This command will write filespec to disk as a native Abiword file irrespective of the file extension. For export to formats or to a different filespec use the $id file save command.

Returns 1 if the filespec is successfully saved, other wise 0.
id clear option (stub-only)
id class

Returns the class of the widget, i.e. abiwidget.
id delete
Deletes the widget and its associated Tcl command.
id undo

Undo the previous edit operation.

id
redo

Redo a previously undone operation.
id copy
Copies the selected text to the clipboard.
id cut
Copies the selected text to the clipboard and removes it from the widget.
id paste
Pastes text from the clipboard at the current cursor position.

special  

id align option

Align the positioning of the paragraph of text containing the cursor to one of : 
center  
justify

right

left


id select
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

all

block

line

word

bob  
bod  
bow  
eob  
eod  
eol  
eow  
left  
right  
nextLine  
pageDown

prevLine
 
screenDown
 
screenUp
 
to
 
       
id  erase
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

bob  
bod  
bol
bow  
eob  
eod  
eol  
eow  
left  
right  
id  insert
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

data  
space  
table

image
 
id  edit
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

header  
footer  
id  file
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

open  
save  
id  remove
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

header  
footer  
id  toggle
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

bold  
underLine
 
bottomLine

insertMode

italic

overLine

plain

strike

sub

super

topLine

unindent

bullets

numbering

id  view
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

marks  
print
 
normal

onLine

id  moveto
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

bob  
bod
 
bol

bow

eob

eod

eol

eow

left

right

nextLine

nextPage

nextScreen

prevLine

prevPage

prevScreen

id  zoom
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

whole
 
width
 
id  set
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

showMargin
 
wordSelections
 
fontName

fontSize

style

textColor

zoom

page

authors

id  get
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

showMargin
 
wordSelections
 
fontNames

zoom

page

pageCount

pointer

authors

id  find
A number of commands require an offset keyword in to order to complete their operations. Here is a list of the keywords used in the Abiwidget API. 

string
 
prev
 
next


Example

Comments