AbiWidget

From AbiWiki

(Difference between revisions)
Jump to: navigation, search
(→AbiWidget)
m (Reverted edits by Ikexadyma (Talk) to last revision by MartinSevior)
 
(16 intermediate revisions not shown)
Line 1: Line 1:
==AbiWidget==
==AbiWidget==
-
AbiWidget is a full Word Processing canvas which is also a genuine [[GtkWidget] http://library.gnome.org/devel/gtk/stable/] that can be incorporated in other programs.
+
AbiWidget is a full Word Processing canvas which is also a genuine [http://library.gnome.org/devel/gtk/stable/ GtkWidget] that can be incorporated in other programs.
-
See the [[AbiWord SDK]] for some example code of how to embed AbiWidget in C code.
+
See the [[AbiWord SDK]] for some example code of how to embed AbiWidget in C code. We have also documented [http://www.abisource.com/wiki/PyAbiWord#A_very_simple_program_-_test.py a small example] to show how AbiWidget is embedded in a PyGTK program.  
There are many powerful commands that control AbiWidget and python bindings that allow AbiWidget to be used
There are many powerful commands that control AbiWidget and python bindings that allow AbiWidget to be used
-
in pyGtk programs. The most prominent is OLPC Write. Here we document the many functions and signals provided by AbiWidget.
+
in [http://www.pygtk.org/ PyGtk] programs. The most prominent is [http://wiki.laptop.org/go/Write OLPC Write]. Here we document the many functions and signals provided by AbiWidget.
==AbiWidget C bindings==
==AbiWidget C bindings==
==AbiWidget Python Bindings==
==AbiWidget Python Bindings==
 +
===Invocation Methods===
 +
<pre>
 +
AbiWidget Canvas()
 +
AbiTable TableCreator()
 +
</pre>
 +
===Insert Table Widget===
===Insert Table Widget===
This little widget can be embedded in a toolbar and allows tables to be interactively inserted into AbiWord
This little widget can be embedded in a toolbar and allows tables to be interactively inserted into AbiWord
Line 24: Line 30:
===AbiWidget Bindings===
===AbiWidget Bindings===
 +
<pre>
<pre>
Line 30: Line 37:
gboolean load_file_from_memory(const gchar * ext_or_mime, const ghcar * buffer, gint sizeBuffer)
gboolean load_file_from_memory(const gchar * ext_or_mime, const ghcar * buffer, gint sizeBuffer)
gboolean align_center()
gboolean align_center()
-
 
+
gboolean align_justify()
-
(define-method align_justify
+
gboolean align_left()
-
  (of-object "AbiWidget")
+
gboolean align_right()
-
  (c-name "abi_widget_align_justify")
+
gboolean copy()
-
  (return-type "gboolean")
+
gboolean cut()
-
)
+
gboolean paste()
-
 
+
gboolean paste_special()
-
(define-method align_left
+
gboolean select_all()
-
  (of-object "AbiWidget")
+
gboolean select_block()
-
  (c-name "abi_widget_align_left")
+
gboolean select_line()
-
  (return-type "gboolean")
+
gboolean select_word()
-
)
+
gboolean undo()
-
 
+
gboolean redo()
-
(define-method align_right
+
gboolean insert_data(const- gchar* data)
-
  (of-object "AbiWidget")
+
gboolean insert_space()
-
  (c-name "abi_widget_align_right")
+
gboolean delete_bob()
-
  (return-type "gboolean")
+
gboolean delete_bod()
-
)
+
gboolean delete_bol()
-
 
+
gboolean delete_bow()
-
(define-method copy
+
gboolean delete_eob()
-
  (of-object "AbiWidget")
+
gboolean delete_eod()
-
  (c-name "abi_widget_copy")
+
gboolean delete_eol()
-
  (return-type "gboolean")
+
gboolean delete_eow()
-
)
+
gboolean delete_left()
-
 
+
gboolean delete_right()
-
(define-method cut
+
gboolean edit_header()
-
  (of-object "AbiWidget")
+
gboolean edit_footer()
-
  (c-name "abi_widget_cut")
+
gboolean file_open()
-
  (return-type "gboolean")
+
gboolean file_save()
-
)
+
gboolean remove_header()
-
 
+
gboolean remove_footer()
-
(define-method paste
+
gboolean save(const gchar* fname, constgchar* extention_or_mimetype, const gchar* exp_props)
-
  (of-object "AbiWidget")
+
gboolean save_immediate()
-
  (c-name "abi_widget_paste")
+
gboolean select_bob()  
-
  (return-type "gboolean")
+
gboolean select_bod()  
-
)
+
gboolean select_bol()  
-
 
+
gboolean select_bow()
-
(define-method paste_special
+
gboolean select_eob()  
-
  (of-object "AbiWidget")
+
gboolean select_eod()
-
  (c-name "abi_widget_paste_special")
+
gboolean select_eol()   
-
  (return-type "gboolean")
+
gboolean select_eow()  
-
)
+
gboolean select_left()
-
 
+
gboolean select_next_line()
-
(define-method select_all
+
gboolean select_page_down()
-
  (of-object "AbiWidget")
+
gboolean select_page_up()  
-
  (c-name "abi_widget_select_all")
+
gboolean select_prev_line()
-
  (return-type "gboolean")
+
gboolean select_right()
-
)
+
gboolean select_screen_down()
-
 
+
gboolean select_screen_up()
-
(define-method select_block
+
gboolean select_to_xy(gint32 x, gint32 y)
-
  (of-object "AbiWidget")
+
gboolean toggle_bold()
-
  (c-name "abi_widget_select_block")
+
gboolean toggle_underline()
-
  (return-type "gboolean")
+
gboolean toggle_bottomline()
-
)
+
gboolean toggle_insert_mode()
-
 
+
gboolean toggle_italic()
-
(define-method select_line
+
gboolean toggle_overline()
-
  (of-object "AbiWidget")
+
gboolean toggle_plain()
-
  (c-name "abi_widget_select_line")
+
gboolean toggle_strike()
-
  (return-type "gboolean")
+
gboolean toggle_sub()
-
)
+
gboolean toggle_super()
-
 
+
gboolean toggle_topline()
-
(define-method select_word
+
gboolean toggle_unindent()
-
  (of-object "AbiWidget")
+
gboolean toggle_bullets()
-
  (c-name "abi_widget_select_word")
+
gboolean toggle_numbering()
-
  (return-type "gboolean")
+
gboolean view_formatting_marks()
-
)
+
gboolean view_print_layout()
-
 
+
gboolean view_normal_layout()
-
(define-method undo
+
gboolean view_online_layout()
-
  (of-object "AbiWidget")
+
gboolean moveto_bob()
-
  (c-name "abi_widget_undo")
+
gboolean moveto_bod()
-
  (return-type "gboolean")
+
gboolean moveto_bol()
-
)
+
gboolean moveto_bop()
-
 
+
gboolean moveto_bow()
-
(define-method redo
+
gboolean moveto_eob()
-
  (of-object "AbiWidget")
+
gboolean moveto_eod()
-
  (c-name "abi_widget_redo")
+
gboolean moveto_eol()
-
  (return-type "gboolean")
+
gboolean moveto_eow()
-
)
+
gboolean moveto_left()
-
 
+
gboolean moveto_next_line()
-
(define-method insert_data
+
gboolean moveto_next_page()
-
  (of-object "AbiWidget")
+
gboolean moveto_next_screen()
-
  (c-name "abi_widget_insert_data")
+
gboolean moveto_prev_line()
-
  (return-type "gboolean")
+
gboolean moveto_prev_page()
-
  (parameters
+
gboolean moveto_prev_screen()
-
    '("const-gchar*" "data")
+
gboolean moveto_right()
-
  )
+
gboolean zoom_whole()
-
)
+
gboolean zoom_width()
-
 
+
gboolean set_show_margin( gboolean bShowMargin)
-
(define-method insert_space
+
gboolean get_show_margin()
-
  (of-object "AbiWidget")
+
gboolean set_word_selections( gboolean bsetWordSelction)
-
  (c-name "abi_widget_insert_space")
+
gboolean get_word_selections()
-
  (return-type "gboolean")
+
(gchar * szContent, gint iLength) get_content( const-gchar* extention_or_mimetype, const gchar* exp_props)
-
)
+
(gchar * szContent, gint iLength) get_selection( const-gchar* extention_or_mimetype, const gchar* exp_props)
-
 
+
gboolean insert_table(gint32 rows, gint32 cols)
-
(define-method delete_bob
+
gboolean invoke_cmd( gchar* mthdName, gchar* data, gint32 x, gint32 y)
-
  (of-object "AbiWidget")
+
gboolean set_font_name(gchar* szName)
-
  (c-name "abi_widget_delete_bob")
+
gboolean set_font_size( gchar* szSize)
-
  (return-type "gboolean")
+
gboolean set_style(gchar* szName)
-
)
+
gboolean insert_image( gchar* szFile, gboolean positioned)
-
 
+
gboolean set_text_color(guint8 red, guint8 green, guint8 blue)
-
(define-method delete_bod
+
const gchar ** get_font_names()
-
  (of-object "AbiWidget")
+
gboolean set_zoom_percentage(guint32 zoom)
-
  (c-name "abi_widget_delete_bod")
+
gboolean get_zoom_percentage()
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method delete_bol
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_bol")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method delete_bow
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_bow")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
 
+
-
(define-method delete_eob
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_eob")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method delete_eod
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_eod")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method delete_eol
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_eol")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method delete_eow
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_eow")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method delete_left
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_left")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
 
+
-
(define-method delete_right
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_delete_right")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method edit_header
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_edit_header")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method edit_footer
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_edit_footer")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method file_open
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_file_open")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method file_save
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_file_save")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method remove_header
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_remove_header")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method remove_footer
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_remove_footer")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method save
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_save")
+
-
  (parameters
+
-
    '("const-gchar*" "fname")
+
-
    '("const-gchar*" "extention_or_mimetype")
+
-
    '("const-gchar*" "exp_props")
+
-
  )
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method save_immediate
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_save_immediate")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method select_bob  
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_bob")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_bod
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_bod")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_bol
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_bol")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_bow
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_bow")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_eob
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_eob")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_eod
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_eod")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_eol
+
-
  (of-object "AbiWidget")
+
-
   (c-name "abi_widget_select_eol")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_eow
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_eow")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
   
+
-
(define-method select_left
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_left")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_next_line
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_next_line")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_page_down
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_page_down")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_page_up
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_page_up")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
   
+
-
(define-method select_prev_line
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_prev_line")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_right
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_right")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_screen_down
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_screen_down")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_screen_up
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_screen_up")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method select_to_xy
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_select_to_xy")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
    '("gint32" "x")
+
-
    '("gint32" "y")
+
-
  )
+
-
)
+
-
   
+
-
(define-method toggle_bold
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_bold")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
   
+
-
(define-method toggle_underline
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_underline")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_bottomline
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_bottomline")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_insert_mode
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_insert_mode")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_italic
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_italic")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_overline
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_overline")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_plain
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_plain")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_strike
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_strike")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_sub
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_sub")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_super
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_super")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method toggle_topline
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_topline")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method toggle_unindent
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_unindent")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method toggle_bullets
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_bullets")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method toggle_numbering
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_toggle_numbering")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method view_formatting_marks
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_view_formatting_marks")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method view_print_layout
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_view_print_layout")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method view_normal_layout
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_view_normal_layout")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method view_online_layout
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_view_online_layout")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_bob
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_bob")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_bod
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_bod")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_bol
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_bol")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_bop
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_bop")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_bow
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_bow")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_eob
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_eob")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_eod
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_eod")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_eol
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_eol")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_eow
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_eow")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_left
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_left")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_next_line
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_next_line")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_next_page
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_next_page")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_next_screen
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_next_screen")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_prev_line
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_prev_line")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_prev_page
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_prev_page")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_prev_screen
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_prev_screen")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_right
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_right")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method moveto_xy
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_moveto_to_xy")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
    '("gint32" "x")
+
-
    '("gint32" "y")
+
-
  )
+
-
)
+
-
   
+
-
(define-method zoom_whole
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_zoom_whole")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method zoom_width
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_zoom_width")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method set_show_margin
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_set_show_margin")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
    '("gboolean" "b")
+
-
  )
+
-
)
+
-
 
+
-
(define-method get_show_margin
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_get_show_margin")
+
-
  (return-type "gboolean")
+
-
)
+
-
   
+
-
(define-method set_word_selections
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_set_word_selections")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
    '("gboolean" "b")
+
-
  )
+
-
)
+
-
   
+
-
(define-method get_word_selections
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_get_word_selections")
+
-
  (return-type "gboolean")
+
-
)
+
-
 
+
-
(define-method get_content
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_get_content")
+
-
  (return-type "gchar*")
+
-
  (parameters
+
-
    '("const-gchar*" "extention_or_mimetype")
+
-
    '("const-gchar*" "exp_props")
+
-
    '("gint*" "iLength")
+
-
  )
+
-
)
+
-
 
+
-
(define-method get_selection
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_get_selection")
+
-
  (return-type "gchar*")
+
-
  (parameters
+
-
    '("const-gchar*" "extention_or_mimetype")
+
-
    '("gint*" "iLength")
+
-
  )
+
-
)
+
-
 
+
-
(define-method insert_table
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_insert_table")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("gint32" "rows")
+
-
  '("gint32" "cols")
+
-
  )
+
-
)
+
-
 
+
-
(define-method invoke_cmd
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_invoke_ex")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("gchar*" "mthdName")
+
-
  '("gchar*" "data")
+
-
  '("gint32" "x")
+
-
  '("gint32" "y")
+
-
  )
+
-
)
+
-
 
+
-
(define-method set_font_name
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_set_font_name")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("gchar*" "szName")
+
-
  )
+
-
)
+
-
 
+
-
(define-method set_font_size
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_set_font_size")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("gchar*" "szSize")
+
-
  )
+
-
)
+
-
 
+
-
(define-method set_style
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_set_style")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("gchar*" "szName")
+
-
  )
+
-
)
+
-
 
+
-
(define-method insert_image
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_insert_image")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("gchar*" "szFile")
+
-
  '("gboolean" "positioned")
+
-
  )
+
-
)
+
-
 
+
-
(define-method set_text_color
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_set_text_color")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("guint8" "red")
+
-
  '("guint8" "green")
+
-
  '("guint8" "blue")
+
-
  )
+
-
)
+
-
 
+
-
(define-method get_font_names
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_get_font_names")
+
-
  (return-type "const-gchar**")
+
-
)
+
-
 
+
-
(define-method set_zoom_percentage
+
-
  (of-object "AbiWidget")
+
-
  (c-name "abi_widget_set_zoom_percentage")
+
-
  (return-type "gboolean")
+
-
  (parameters
+
-
  '("guint32" "zoom")
+
-
  )
+
-
)
+
-
 
+
-
guint32 get_zoom_percentage()
+
void set_find_string(gchar * string)
void set_find_string(gchar * string)
gboolean find_next()
gboolean find_next()
Line 723: Line 146:
void set_current_page(guint32 PageNo)
void set_current_page(guint32 PageNo)
guint32 get_current_page_num()
guint32 get_current_page_num()
-
 
+
GdkPixbuf render_page_to_image(guint32 PageNumber)
</pre>
</pre>
 +
 +
[[Category:Developer]]
 +
[[Category:Python]]

Current revision as of 13:14, 27 November 2010

Contents

AbiWidget

AbiWidget is a full Word Processing canvas which is also a genuine GtkWidget that can be incorporated in other programs. See the AbiWord SDK for some example code of how to embed AbiWidget in C code. We have also documented a small example to show how AbiWidget is embedded in a PyGTK program.

There are many powerful commands that control AbiWidget and python bindings that allow AbiWidget to be used in PyGtk programs. The most prominent is OLPC Write. Here we document the many functions and signals provided by AbiWidget.

AbiWidget C bindings

AbiWidget Python Bindings

Invocation Methods

AbiWidget Canvas()
AbiTable TableCreator()

Insert Table Widget

This little widget can be embedded in a toolbar and allows tables to be interactively inserted into AbiWord 

GtkWidget* abi_table_new()
void set_selected(guint rows, guint cols)
(guint rows, guint cols) get_selected()
void set_max_size(guint rows, guint cols)
(guint rows, guint cols) get_max_size()
none set_labels(gchar* szTable", gchar* szCancel)
GtkWidget * label()
void set_icon(GtkWidget * icon)

AbiWidget Bindings


GtkWidget * abi_widget_new()
gboolean load_file(const gchar * fname, const ghcar *  mimetype)
gboolean load_file_from_memory(const gchar * ext_or_mime, const ghcar * buffer, gint sizeBuffer)
gboolean align_center()
gboolean align_justify()
gboolean align_left()
gboolean  align_right()
gboolean copy()
gboolean cut()
gboolean paste()
gboolean paste_special()
gboolean select_all()
gboolean select_block()
gboolean select_line()
gboolean select_word()
gboolean undo()
gboolean redo()
gboolean insert_data(const- gchar* data)
gboolean insert_space()
gboolean delete_bob()
gboolean delete_bod()
gboolean delete_bol()
gboolean delete_bow()
gboolean delete_eob()
gboolean delete_eod()
gboolean delete_eol()
gboolean delete_eow()
gboolean delete_left()
gboolean delete_right()
gboolean edit_header()
gboolean edit_footer()
gboolean file_open()
gboolean file_save()
gboolean remove_header()
gboolean remove_footer()
gboolean save(const gchar* fname, constgchar* extention_or_mimetype, const gchar* exp_props)
gboolean save_immediate()
gboolean select_bob() 
gboolean select_bod() 
gboolean select_bol() 
gboolean select_bow()
gboolean select_eob() 
gboolean select_eod()
gboolean select_eol()   
gboolean select_eow() 
gboolean select_left()
gboolean select_next_line()
gboolean select_page_down()
gboolean select_page_up() 
gboolean select_prev_line()
gboolean select_right()
gboolean select_screen_down()
gboolean select_screen_up()
gboolean select_to_xy(gint32 x, gint32 y)
gboolean toggle_bold()
gboolean toggle_underline()
gboolean toggle_bottomline()
gboolean toggle_insert_mode()
gboolean toggle_italic()
gboolean toggle_overline()
gboolean toggle_plain()
gboolean toggle_strike()
gboolean toggle_sub()
gboolean toggle_super()
gboolean toggle_topline()
gboolean toggle_unindent()
gboolean toggle_bullets()
gboolean toggle_numbering()
gboolean view_formatting_marks()
gboolean view_print_layout()
gboolean view_normal_layout()
gboolean view_online_layout()
gboolean moveto_bob()
gboolean moveto_bod()
gboolean moveto_bol()
gboolean moveto_bop()
gboolean moveto_bow()
gboolean moveto_eob()
gboolean moveto_eod()
gboolean moveto_eol()
gboolean moveto_eow()
gboolean moveto_left()
gboolean moveto_next_line()
gboolean moveto_next_page()
gboolean moveto_next_screen()
gboolean moveto_prev_line()
gboolean moveto_prev_page()
gboolean moveto_prev_screen()
gboolean moveto_right()
gboolean zoom_whole()
gboolean zoom_width()
gboolean set_show_margin( gboolean bShowMargin)
gboolean get_show_margin()
gboolean set_word_selections( gboolean bsetWordSelction)
gboolean  get_word_selections()
(gchar * szContent, gint iLength) get_content( const-gchar* extention_or_mimetype, const gchar* exp_props)
(gchar * szContent, gint iLength) get_selection( const-gchar* extention_or_mimetype, const gchar* exp_props)
gboolean insert_table(gint32 rows, gint32 cols)
gboolean invoke_cmd( gchar* mthdName, gchar* data, gint32 x, gint32 y)
gboolean set_font_name(gchar* szName)
gboolean set_font_size( gchar* szSize)
gboolean set_style(gchar* szName)
gboolean insert_image( gchar* szFile, gboolean positioned)
gboolean set_text_color(guint8 red, guint8 green, guint8 blue)
const gchar ** get_font_names()
gboolean set_zoom_percentage(guint32 zoom)
gboolean get_zoom_percentage()
void set_find_string(gchar * string)
gboolean find_next()
gboolean find_prev()
guint32 get_num_pages()
void set_current_page(guint32 PageNo)
guint32 get_current_page_num()
GdkPixbuf render_page_to_image(guint32 PageNumber)
Retrieved from "http://abiword.com/wiki/AbiWidget"