Permalink
Browse files

09-03-2006 Zac Bowling <zac@zacbowling.com>

	README: updated description
	docs/README: simple set of api documentation



svn path=/trunk/gtkspell-sharp/; revision=57748
  • Loading branch information...
1 parent 9bf5a0f commit 8eef71cfb6cdee4d211fb55895464e69b7523714 @zbowling zbowling committed Mar 9, 2006
Showing with 75 additions and 12 deletions.
  1. +10 −5 ChangeLog
  2. +25 −7 README
  3. +40 −0 docs/README
View
15 ChangeLog
@@ -1,11 +1,16 @@
-13-04-2005 Zac Bowling <zac@zacbowling.com>
- sources/gtkspell-sharp.sources:
- sources/gtkspell-2.0.10.tar.gz: added sources used to build
- sources/Win32/libgtkspell.dll: added win32 dll for convience
- api/*: removed, sources generate directly to raw now
+09-03-2006 Zac Bowling <zac@zacbowling.com>
+ README: updated description
+ docs/README: simple set of api documentation
24-03-2005 Rafael Teixeira <rafaelteixeirabr@hotmail.com>
sample/TestGtkSpell.cs
-- added a delete event handler to end the application when closing the window
-- now accepts an optional command line argument to specify locale.
Ex: "mono TestGtkSpell.exe pt-br", defaults to en-us as before
+
+13-04-2005 Zac Bowling <zac@zacbowling.com>
+ sources/gtkspell-sharp.sources:
+ sources/gtkspell-2.0.10.tar.gz: added sources used to build
+ sources/Win32/libgtkspell.dll: added win32 dll for convience
+ api/*: removed, sources generate directly to raw now
+
View
32 README
@@ -1,14 +1,32 @@
+GtkSpell#
+
+An interactive, realtime spell checker for Gtk.TextView.
+Similar to MS Word's red squiggly spell checking feature.
+
+GtkSpell# wraps libgtkspell 2.0, which wraps any installed aspell
+or ispell spellchecking library.
+
+
+Copyright(C) 2005-2006, Zac Bowling
+ Licenced under the LGPL v1.1 (or at your option, any later version).
+
+Special thanks to:
+ Rafael Teixeira (Samples)
+ Mike Kestner (GAPI and gtk#)
+
+
Building:
-./configure
-make
-make install
+$ ./configure
+$ make
+$ sudo make install
WIN32 runtimes:
-GtkSpell will build on WIN32, but for simplisty I use GAIM's GTK+ runtime installer
-http://gaim.sf.net/win32
+ libgtkspell 2.0 will build on WIN32, but for simplisty I use GAIM's GTK+
+ runtime installer as it contains libgtkspell for deploying.
+ http://gaim.sf.net/win32
-You can get the dictionaries and installers for win32 here.
-http://www.aspell.org/win32/
+You can get the dictionaries and installers for win32 here:
+ http://www.aspell.org/win32/
View
40 docs/README
@@ -0,0 +1,40 @@
+
+API DOCS:
+
+GtkSpell.SpellCheck
+{
+ /**** Contstructors ****/
+ // Set language for spell checking by passing in language id string
+ // (eg. "EN-US", "EN-GB"). Pass NULL to use default.
+ SpellCheck(Gtk.TextView, string);
+
+ /**** Members ****/
+ // Set language for spell checking by passing in a locale string
+ // (eg. "EN-US", "EN-GB"). Pass NULL to use default.
+ // Returns false if its unable to set the langauge.
+ bool SetLanguage(string);
+ void RecheckAll();
+ void Detach();
+
+ // This deprecated method will attach a new (and different) GtkSpell checker
+ // to a TextView with the default language. This method returns no errors.
+ [Deprecated] void Attach(Gtk.TextView);
+
+ /**** Static Members ****/
+ // Should return NULL if no SpellCheck was attached before.
+ (static) GtkSpell.SpellCheck GetFromTextView(Gtk.TextView);
+
+ // Really old versions of libgtkspell require you to initalize aspell/ispell
+ // This shouldn't do anything in new versions of libgtkspell.
+ [Deprecated] (static) ErrorFlags Init();
+}
+
+// this enum was really suppost to be used in the future but the only method
+// that uses it is now Deprecated and might not get ever get reused for
+// gtkspell3
+[Deprecated]
+enum GtkSpell.ErrorFlags
+{
+ Backend,
+}
+

0 comments on commit 8eef71c

Please sign in to comment.