Author: junrue Date: Mon Oct 2 10:54:59 2006 New Revision: 283
Added: trunk/docs/manual/ApiReference.html trunk/docs/manual/Footnotes.html trunk/docs/manual/Glossary.html trunk/docs/manual/Graphic-FormsProgrammingReference.wcp trunk/docs/manual/GraphicsPackage.html trunk/docs/manual/ImageDataPlugins.html trunk/docs/manual/Introduction.html trunk/docs/manual/LegalInfo.html trunk/docs/manual/MiscellaneousTopics.html trunk/docs/manual/Prerequisites.html trunk/docs/manual/Support.html trunk/docs/manual/SystemPackage.html trunk/docs/manual/TerminologyConventions.html trunk/docs/manual/WidgetsPackage.html trunk/docs/manual/gfs-native-object.html trunk/docs/manual/gfs-point.html trunk/docs/manual/gfs-rectangle.html trunk/docs/manual/gfs-size.html Removed: trunk/docs/manual/Makefile trunk/docs/manual/api.texinfo trunk/docs/manual/event-functions.texinfo trunk/docs/manual/glossary.texinfo trunk/docs/manual/graphics-functions.texinfo trunk/docs/manual/graphics-types.texinfo trunk/docs/manual/image-plugins.texinfo trunk/docs/manual/layout-functions.texinfo trunk/docs/manual/layout-types.texinfo trunk/docs/manual/miscellaneous.texinfo trunk/docs/manual/overview.texinfo trunk/docs/manual/reference.texinfo trunk/docs/manual/style.css trunk/docs/manual/system-functions.texinfo trunk/docs/manual/system-types.texinfo trunk/docs/manual/terminology.texinfo trunk/docs/manual/widget-functions.texinfo trunk/docs/manual/widget-types.texinfo Log: begin manual overhaul to support CHM
Added: trunk/docs/manual/ApiReference.html ============================================================================== --- (empty file) +++ trunk/docs/manual/ApiReference.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,15 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>API Reference</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<P><FONT face=Arial size=2> This chapter +documents the Graphic-Forms programming interface. All package names are prefixed with +<EM>graphic-forms.uitoolkit</EM>. </FONT></P> +<P> </P></body> +</html>
Added: trunk/docs/manual/Footnotes.html ============================================================================== --- (empty file) +++ trunk/docs/manual/Footnotes.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,39 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Footnotes</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body><FONT face=Arial size=2><FONT face=Arial size=2> +<P class=footnote><SMALL><FONT size=2>[</FONT><A +href="file:///C:/projects/public/graphic-forms/docs/manual/reference/Overview.html#fnd-1" +name=fn-1><FONT size=2>1</FONT></A><FONT size=2>]</FONT></SMALL> a small patch +to enable the <SPAN class=sc>stdcall</SPAN> calling convention for callbacks is +temporarily bundled with Graphic-Forms, see<BR> + +<CODE><FONT +size=3>src/external-libraries/sbcl-callback-patch/</FONT></CODE></P> +<P>[<A href="Prerequisites.html">2</A>] testing on RC1 is +in-progress</P> +<P>[<A href="ImageDataPlugins.html">3</A>] Nowadays, the Windows platform offers +alternatives, such as <SPAN class=sc>gdi+</SPAN> which adds among other features +native support for additional image formats. Graphic-Forms sticks with plain-old +<SPAN class=sc>gdi</SPAN> to avoid the possibility of these alternatives not +being installed.</P> +<P>[<A href="ImageDataPlugins.html">4</A>] As do GUI bindings in other languages +such as Java.</P> +<P>[<A href="ImageDataPlugins.html">5</A>] See the main ImageMagick website at +<A href="http://imagemagick.org">http://imagemagick.org</A> for downloads and +documentation.</P> +<P>[<A href="TerminologyConventions.html">6</A>] This topic gets muddier when edit controls come into +the picture. Text in an edit control is selected despite there being no +notification event; yet there is a notification (event-modify) then the user +types text. I'm choosing to live with this inconsistency, partly because +otherwise my categorization scheme seems to work well; and one can refer to the +act of retrieving edit control selection, confident that developers will know +this means obtaining highlighted text.</P> +<P> </P></FONT> </FONT></body> +</html>
Added: trunk/docs/manual/Glossary.html ============================================================================== --- (empty file) +++ trunk/docs/manual/Glossary.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,86 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Glossary</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body><FONT face=Arial size=2> +<P>This chapter defines fundamental terms encountered throughout the +documentation of Graphic-Forms. </P> </FONT> +<DL> + <DT><FONT face=Courier><SPAN class=samp>accelerator</SPAN></FONT><FONT face=Arial size=2> + <DD><A name=accelerator></A><A name=index-accelerator-301></A>An accelerator + is a key sequence assigned to an application function allowing a user to + bypass navigation of the menu or control hierarchy normally required to invoke + the function. Some accelerators are established by Windows style guidelines, + such as <SPAN class=sc>control-c</SPAN> for the clipboard copy operation from + an Edit menu. Applications may define other accelerators as appropriate. + Accelerators are generally intended for more knowledgeable users and should + not be the sole mechanism for invoking functionality. Compare with <A + href="Glossary.html">mnemonic</A>.<BR><BR></FONT> + <DT><FONT face=Courier><SPAN class=samp>auto-scrolling</SPAN></FONT><FONT face=Arial +size=2> + <DD><A name=index-auto_002dscrolling-302></A>Auto-scrolling is a feature + whereby scrolling occurs as a side effect of user input so content can remain + visible, thus avoiding the need to explicitly manipulate scrollbars to achieve + the same result.<BR><BR></FONT> + <DT><FONT face=Courier><SPAN class=samp>control</SPAN></FONT><FONT face=Arial size=2> + <DD><A name=index-control-303></A>A control is a system-defined window class + whose role is to accept user input and possibly generate notification events + based on such input.<BR><BR></FONT> + <DT><SPAN class=samp><FONT + face=Courier>default action</FONT> </SPAN><FONT face=Arial size=2> + <DD><A name=default-action></A><A + name=index-default-action-304></A>Conceptually, a default action is a + secondary event initiated by user input that is a logical follow-up to a + previous event. Examples of such user gestures include double-clicking an item + in a list box control, or pressing <SPAN class=sc>enter</SPAN> when an edit + control has the keyboard focus. The response to a default action makes use of + context established by the preceding event (e.g., the selection set by an + initial click becomes the context for the double-click response).<BR><BR></FONT> + <DT><SPAN class=samp><FONT + face=Courier>dialog</FONT></SPAN><FONT face=Arial size=2> + <DD><A name=index-dialog-305></A>A dialog is a mechanism for collecting user + input or showing information. The system defines common dialogs for tasks like + choosing files, fonts, or colors. Custom dialogs can be defined by application + code.<BR><BR></FONT> + <DT><SPAN class=samp><FONT + face=Courier>extension</FONT></SPAN><FONT face=Arial size=2> + <DD><A name=extension></A><A name=index-extension-306></A>An extension is code + providing additional functionality beyond the original scope of a system. An + extension framework encourages modularity. More importantly, it is a conscious + design choice to allow a system to be stretched beyond what the original + designers may have anticipated. Compare with <A + href="Glossary.html">plugin</A>.<BR><BR></FONT> + <DT><SPAN class=samp><FONT + face=Courier>menu</FONT></SPAN><FONT face=Arial size=2> + <DD><A name=index-menu-307></A>A collection of menu items presented within a + single rectangular region. Menus are often anchored to a menu bar, but may + also be invoked in a context-sensitive manner via the mouse or an <A + href="Glossary.html">accelerator</A>.<BR><BR></FONT> + <DT><SPAN class=samp><FONT + face=Courier>mix-in class</FONT> </SPAN><FONT face=Arial size=2> + <DD><A name=mix_002din-class></A><A name=index-mix_002din-class-308></A>A + mix-in class represents a specific abstraction that complements the role(s) of + other class(es) in a class hierarchy.<BR><BR></FONT> + <DT><SPAN class=samp><FONT + face=Courier>mnemonic</FONT></SPAN><FONT face=Arial size=2> + <DD><A name=mnemonic></A><A name=index-mnemonic-309></A>A mnemonic is a key + sequence (usually a single character modified by the <SPAN class=sc>alt</SPAN> + key) enabling mouse-free navigation of a menu or control hierarchy to invoke + an application function. Depending on the user's system settings, mnemonic + characters may be hidden until the user presses the <SPAN class=sc>alt</SPAN> + key. Compare with <A + href="Glossary.html">accelerator</A>.<BR><BR></FONT> + <DT><SPAN class=samp><FONT + face=Courier>plugin</FONT></SPAN><FONT face=Arial size=2> + <DD><A name=plugin></A><A name=index-plugin-310></A>A plugin is code + integrated into a larger system in order to implement a specific instance of + an established category of services. A plugin framework encourages modularity + within a defined scope of functionality. Compare with <A + href="Glossary.html">extension</A>. + <DD> </DD></DL></FONT></body> +</html>
Added: trunk/docs/manual/Graphic-FormsProgrammingReference.wcp ============================================================================== --- (empty file) +++ trunk/docs/manual/Graphic-FormsProgrammingReference.wcp Mon Oct 2 10:54:59 2006 @@ -0,0 +1,266 @@ +[GENERAL] +Title=Graphic-Forms Programming Reference +RootDir= +DefaultTopic=Introduction.html +CompiledFile=graphic-forms.chm +CustomTemplate= +DefaultTemplate=1 +Encoding=Windows-1252 +Language=0x0409 +DeleteProject=0 +ViewCompiledFile=1 +HasChild=0 +NoChild=10 +HtmlHelpTemplate= +HtmlHelpTitle=Graphic-Forms Programming Reference +HtmlHelpTitleSame=1 +WebHelpDefault=Introduction.html +WebHelpOutputFolder=c:\projects\public\graphic-forms\docs\manual\html +WebHelpTemplate= +WebHelpTitle=Graphic-Forms Programming Reference +WebHelpDefaultSame=1 +WebHelpTemplateSame=0 +WebHelpTilteSame=1 +StartFromRoot=1 +AutoCollapse=0 +DrawLines=1 +SingleHtmlFilename=index.html +SingleHtmlOutputFolder=C:\tmp\install +SingleHtmlTitle=Graphic-Forms Programming Reference +SingleHtmlHasToc=1 +SingleHtmlSame=1 +HeadProperties=1 +PageProperties=1 +RealColorIcon=0 +ShowIndex=1 +NavWidth=200 +WebFontColor=#000000 +WebBackColor=#DCDBD6 +HHPFolder= + +[CHMSetting] +Top=50 +Left=50 +Height=500 +Width=700 +PaneWidth=250 +DefaultTab=0 +ShowMSDNMenu=0 +ShowPanesToolbar=1 +ShowPane=1 +HideToolbar=0 +HideToolbarText=0 +StayOnTop=0 +Maximize=0 +Hide=1 +Locate=0 +Back=1 +bForward=1 +Stop=0 +Refresh=1 +Home=1 +Print=1 +Option=1 +Jump1=0 +Jump2=0 +AutoShowHide=0 +AutoSync=1 +Content=1 +Index=1 +Search=1 +Favorite=1 +UseFolder=0 +AutoTrack=0 +SelectRow=0 +PlusMinus=1 +ShowSelection=1 +ShowRoot=1 +DrawLines=1 +AutoExpand=0 +RightToLeft=0 +LeftScroll=0 +Border=0 +DialogFrame=0 +RaisedEdge=0 +SunkenEdge=0 +SavePosition=1 +ContentsFont=,8,0 +IndexFont=,8,0 +Title=Graphic-Forms Programming Reference(Created by WinCHM Prov3.23 unregistered version!) +Language=0x0409 +Font= +DefaultTopic=Introduction.html + +[TOPICS] +TitleList=17 +TitleList.Title.0=Legal Information +TitleList.Level.0=0 +TitleList.Url.0=LegalInfo.html +TitleList.Icon.0=0 +TitleList.Status.0=0 +TitleList.Keywords.0= +TitleList.ContextNumber.0= +TitleList.ApplyTemp.0=0 +TitleList.Expanded.0=0 +TitleList.Kind.0=0 +TitleList.Title.1=Introduction +TitleList.Level.1=0 +TitleList.Url.1=Introduction.html +TitleList.Icon.1=0 +TitleList.Status.1=0 +TitleList.Keywords.1= +TitleList.ContextNumber.1= +TitleList.ApplyTemp.1=0 +TitleList.Expanded.1=0 +TitleList.Kind.1=0 +TitleList.Title.2=Prerequisites +TitleList.Level.2=1 +TitleList.Url.2=Prerequisites.html +TitleList.Icon.2=0 +TitleList.Status.2=0 +TitleList.Keywords.2= +TitleList.ContextNumber.2= +TitleList.ApplyTemp.2=0 +TitleList.Expanded.2=0 +TitleList.Kind.2=0 +TitleList.Title.3=Support and Feedback +TitleList.Level.3=1 +TitleList.Url.3=Support.html +TitleList.Icon.3=0 +TitleList.Status.3=0 +TitleList.Keywords.3= +TitleList.ContextNumber.3= +TitleList.ApplyTemp.3=0 +TitleList.Expanded.3=0 +TitleList.Kind.3=0 +TitleList.Title.4=API Reference +TitleList.Level.4=0 +TitleList.Url.4=ApiReference.html +TitleList.Icon.4=0 +TitleList.Status.4=0 +TitleList.Keywords.4= +TitleList.ContextNumber.4= +TitleList.ApplyTemp.4=0 +TitleList.Expanded.4=1 +TitleList.Kind.4=0 +TitleList.Title.5=Graphics Package +TitleList.Level.5=1 +TitleList.Url.5=GraphicsPackage.html +TitleList.Icon.5=0 +TitleList.Status.5=0 +TitleList.Keywords.5= +TitleList.ContextNumber.5= +TitleList.ApplyTemp.5=0 +TitleList.Expanded.5=0 +TitleList.Kind.5=0 +TitleList.Title.6=System Package +TitleList.Level.6=1 +TitleList.Url.6=SystemPackage.html +TitleList.Icon.6=0 +TitleList.Status.6=0 +TitleList.Keywords.6= +TitleList.ContextNumber.6= +TitleList.ApplyTemp.6=0 +TitleList.Expanded.6=1 +TitleList.Kind.6=0 +TitleList.Title.7=native-object +TitleList.Level.7=2 +TitleList.Url.7=gfs-native-object.html +TitleList.Icon.7=0 +TitleList.Status.7=0 +TitleList.Keywords.7= +TitleList.ContextNumber.7= +TitleList.ApplyTemp.7=0 +TitleList.Expanded.7=0 +TitleList.Kind.7=0 +TitleList.Title.8=point +TitleList.Level.8=2 +TitleList.Url.8=gfs-point.html +TitleList.Icon.8=0 +TitleList.Status.8=0 +TitleList.Keywords.8= +TitleList.ContextNumber.8= +TitleList.ApplyTemp.8=0 +TitleList.Expanded.8=0 +TitleList.Kind.8=0 +TitleList.Title.9=rectangle +TitleList.Level.9=2 +TitleList.Url.9=gfs-rectangle.html +TitleList.Icon.9=0 +TitleList.Status.9=0 +TitleList.Keywords.9= +TitleList.ContextNumber.9= +TitleList.ApplyTemp.9=0 +TitleList.Expanded.9=0 +TitleList.Kind.9=0 +TitleList.Title.10=size +TitleList.Level.10=2 +TitleList.Url.10=gfs-size.html +TitleList.Icon.10=0 +TitleList.Status.10=0 +TitleList.Keywords.10= +TitleList.ContextNumber.10= +TitleList.ApplyTemp.10=0 +TitleList.Expanded.10=0 +TitleList.Kind.10=0 +TitleList.Title.11=Widgets Package +TitleList.Level.11=1 +TitleList.Url.11=WidgetsPackage.html +TitleList.Icon.11=0 +TitleList.Status.11=0 +TitleList.Keywords.11= +TitleList.ContextNumber.11= +TitleList.ApplyTemp.11=0 +TitleList.Expanded.11=0 +TitleList.Kind.11=0 +TitleList.Title.12=Miscellaneous Topics +TitleList.Level.12=0 +TitleList.Url.12=MiscellaneousTopics.html +TitleList.Icon.12=0 +TitleList.Status.12=0 +TitleList.Keywords.12= +TitleList.ContextNumber.12= +TitleList.ApplyTemp.12=0 +TitleList.Expanded.12=0 +TitleList.Kind.12=0 +TitleList.Title.13=Image Data Plugins +TitleList.Level.13=1 +TitleList.Url.13=ImageDataPlugins.html +TitleList.Icon.13=0 +TitleList.Status.13=0 +TitleList.Keywords.13= +TitleList.ContextNumber.13= +TitleList.ApplyTemp.13=0 +TitleList.Expanded.13=0 +TitleList.Kind.13=0 +TitleList.Title.14=Terminology Conventions +TitleList.Level.14=0 +TitleList.Url.14=TerminologyConventions.html +TitleList.Icon.14=0 +TitleList.Status.14=0 +TitleList.Keywords.14= +TitleList.ContextNumber.14= +TitleList.ApplyTemp.14=0 +TitleList.Expanded.14=0 +TitleList.Kind.14=0 +TitleList.Title.15=Glossary +TitleList.Level.15=0 +TitleList.Url.15=Glossary.html +TitleList.Icon.15=0 +TitleList.Status.15=0 +TitleList.Keywords.15= +TitleList.ContextNumber.15= +TitleList.ApplyTemp.15=0 +TitleList.Expanded.15=0 +TitleList.Kind.15=0 +TitleList.Title.16=Footnotes +TitleList.Level.16=0 +TitleList.Url.16=Footnotes.html +TitleList.Icon.16=0 +TitleList.Status.16=0 +TitleList.Keywords.16= +TitleList.ContextNumber.16= +TitleList.ApplyTemp.16=0 +TitleList.Expanded.16=0 +TitleList.Kind.16=1 +
Added: trunk/docs/manual/GraphicsPackage.html ============================================================================== --- (empty file) +++ trunk/docs/manual/GraphicsPackage.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,20 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Graphics Package</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body><FONT face=Arial size=2> +<H4><FONT face=Arial>Full Package Name</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>graphic-forms.uitoolkit.graphics</FONT></P> +<H4><FONT face=Arial>Nickname</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>GFG</FONT></P> +<H4><FONT face=Arial>Synopsis</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2> This package contains the symbols corresponding +to graphics-related classes, drawing operations, and meta-data. This +package and GFW together comprise the bulk of the public API.</FONT></P> +<P> </P> </FONT></body> +</html>
Added: trunk/docs/manual/ImageDataPlugins.html ============================================================================== --- (empty file) +++ trunk/docs/manual/ImageDataPlugins.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,130 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Image Data Plugins</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4><FONT face=Arial>Rationale</FONT></H4> +<P><FONT face=Arial size=2>An important feature of a user interface library is the +display of graphical images, which are aggregates of pixel data and color +information. The Windows <SPAN class=sc>GDI</SPAN> provides adequate support[</FONT> + <A href="Footnotes.html"><FONT +face=Arial size=2>3</FONT></A><FONT face=Arial size=2>] for the basic tasks of creating +system objects populated with image data, drawing on them, rendering them on the +screen, and querying their attributes. Central to the <SPAN class=sc>gdi</SPAN> +concept of an image is the <EM>bitmap</EM>. This format has a long history which +becomes evident as one learns about features designed at a time when memory and +CPU performance were markedly constrained compared to today's machines. For our +purposes, the <SPAN class=sc>gdi</SPAN> bitmap serves as a normalized +representation of image data. Graphic-Forms encapsulates <SPAN +class=sc>gdi</SPAN> bitmap functionality via the +graphics-context and image classes, plus related functions and +macros.</FONT> + +</P> +<P><FONT face=Arial size=2>A traditional Windows application embeds bitmap data within its binary +executable (or <SPAN class=sc>DLL</SPAN>) via the Windows resource compiler. +Such an application then uses Win32 <SPAN class=sc>API</SPAN> +calls to access the resource data and instantiate bitmap objects. Windows +applications may also choose to store image data in other locations, such as +within files on disk. Graphic-Forms relies on this latter arrangement instead of +the resource infrastructure.[</FONT> + + + +<A href="Footnotes.html"><FONT face=Arial +size=2>4</FONT></A><FONT face=Arial size=2>]</FONT></P> +<P><FONT face=Arial size=2>There are many image formats in use today. Whether images +are stored as <SPAN class=sc>gif</SPAN>, <SPAN class=sc>jpeg</SPAN>, <SPAN +class=sc>png</SPAN>, <SPAN class=sc>bmp</SPAN>, or some other format, there must +be code to read the file data and convert it into a <SPAN class=sc>gdi</SPAN> bitmap format for use with +drawing operations. This is the problem solved by the image data plugin +mechanism in Graphic-Forms. It is solved in a manner insulating +format-independent code in the main library from format-specific details, and in +a manner allowing applications to provide their own code to do +likewise.</FONT> + + + + +</P> +<H4><FONT face=Arial>Image file loading</FONT></H4> +<P><FONT face=Arial size=2>When an image file is to be loaded, such as when a <SPAN +class=sc>pathname</SPAN> is supplied to the <CODE>:file</CODE> keyword for the +image or icon-bundle classes, the library traverses a list of file loader +functions bound to the <CODE>gfg::*image-plugins*</CODE> variable � +<CODE>funcall</CODE>'ing each one in turn until one of them returns a non-<SPAN +class=sc>nil</SPAN> list, or the members of <CODE>gfg::*image-plugins*</CODE> is exhausted. +In the latter case, a toolkit-error is raised to notify application code that no +registered plugin supports the file. </FONT> + + </P> +<P><FONT face=Arial size=2>Under normal circumstances, the library will manage the list bound to +<CODE>gfg::*image-plugins*</CODE> behind the scenes. However, applications +requiring precise control over loader function calling order may directly modify +<CODE>gfg::*image-plugins*</CODE> <EM>but must take care to do so properly</EM>. Improper +modifications, such as accidentally assigning some other data structure, or +adding the wrong kind of object, will result in program errors.</FONT> + + +</P> +<H4><FONT face=Arial>Plugins bundled with the library</FONT></H4> +<P><FONT face=Arial size=2>Graphic-Forms includes two +plugins in the distribution. </FONT> </P> +<P><FONT face=Arial size=2>The <EM>Default</EM> plugin is available to applications unless the +<CODE>:skip-default-plugin</CODE> keyword symbol is pushed onto +<CODE>*features*</CODE> prior to loading the system. This plugin implements +support for the <SPAN class=sc>bmp</SPAN> and <SPAN class=sc>ico</SPAN> formats directly in Common Lisp, thus imposing +no additional external dependencies on applications. </FONT> + + </P> +<P><FONT face=Arial size=2>The <EM>ImageMagick</EM> plugin is loaded when the +<CODE>:load-imagemagick-plugin</CODE> keyword symbol is pushed onto +<CODE>*features*</CODE> prior to loading the system. Thanks to the ImageMagick +library, this plugin supports most of the image formats one might expect to +need. However, it requires additional preparation compared to the +<EM>Default</EM> plugin. Developers must +download the ImageMagick Q16 distribution and install it.[</FONT> + +<A href="Footnotes.html"><FONT +face=Arial size=2>5</FONT></A><FONT face=Arial size=2> + ] When delivering applications, the developer must +execute the ImageMagick installation process, or else replicate the expected +directory structure and registry entries. Also, bear in mind that due to the +rich functionality offered by ImageMagick, applications will pull in additional +<SPAN class=sc>dll</SPAN>s and may have larger memory +requirements.</FONT> <A +href="file:///C:/projects/public/graphic-forms/docs/manual/reference/Image-data-plugins.html#fn-3" +rel=footnote name=fnd-3><SUP></SUP></A></P> +<H4><FONT face=Arial>Implementing additional +plugins</FONT> </H4> +<P><FONT face=Arial><FONT size=2><STRONG>FIXME:</STRONG> <EM>add more info to this subsection once the plugin +system has matured a bit.</EM> +</FONT></FONT> </P> +<P><FONT face=Arial size=2>As described in the rationale, +the role of an image data plugin is to translate an external library +representation of image data. In a nutshell, this is accomplished by subclassing +image-data-plugin and implementing certain generic functions. Third parties may +implement and register additional plugins in an identical fashion. </FONT> + + + </P> +<P><FONT face=Arial size=2>As a convenience, the symbol <CODE>gfg::*image-file-types*</CODE> is bound to +an <SPAN class=sc>alist</SPAN> where the first of each pair is a +string naming a file extension, and the second of each pair is a string +supplying a brief description of the format. Plugin developers may retrieve +these pairs to avoid duplication of the same information in their own code. +</FONT> + + + </P> +<P><FONT face=Arial size=2>Developers are welcome to inspect the source code of bundled plugins (located +under <CODE>src/uitoolkit/graphics/plugins</CODE> in the distribution) +for additional hints as to how these plugins may be implemented.</FONT> + </P> +<P><FONT face=Arial size=2></FONT> </P></body> +</html>
Added: trunk/docs/manual/Introduction.html ============================================================================== --- (empty file) +++ trunk/docs/manual/Introduction.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,59 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Introduction</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4><FONT face=Arial>Background</FONT> </H4> +<P><FONT face="Arial" size =2>Graphic-Forms is a +user interface library implemented in Common Lisp focusing on the Windows +platform. Graphic-Forms is licensed under the terms of the BSD License. +</FONT> + + </P> +<P><FONT face="Arial" size =2>The goal is to +provide a Common Lisp-based toolkit for developing GUI applications on Windows. +GUI features are encapsulated by a thin abstraction layer offering a +Lisp-friendly interface. The library can be extended via Common Lisp bindings +for system APIs, avoiding a prerequisite for coding ability in a non-Lisp +programming language. </FONT> + + + + </P> +<P><FONT face="Arial" size =2>Why implement another +UI toolkit? Applications that need portability across windowing systems are +served today by projects such as LTK or wxCL in the open-source world, or the +toolkits provided by commercial vendors. The target audience of Graphic-Forms +consists of GUI developers focused on the Windows platform who want to leverage +platform-specific features. </FONT> + + + + </P> +<P><FONT face="Arial" size =2>Long-term goals for +this project may include implementing an application framework on top of the +toolkit, or a rapid UI development language, or a UI design tool, or some +combination thereof. </FONT> + + </P> +<P><FONT face="Arial" size =2>The remainder of this +chapter provides basic information for programmers that want to use +Graphic-Forms in their projects as well as contributors. </FONT> + </P> +<P><FONT face=Arial><FONT size=2><STRONG>Caution:</STRONG> The information provided in this manual +is subject to change. The author and contributors reserve the right to make API +changes unless and until the interfaces are deemed stable, at which time a +policy for backwards compatibility will be published. </FONT></FONT> + + + </P> +<H4><FONT face=Arial>Project Website</FONT> </H4><FONT face=Arial size=2> +<P><A +href="http://common-lisp.net/project/graphic-forms%22%3Ehttp://common-lisp.net/pro...</A></P></FONT><FONT face=Arial size=2> +<P> </P></FONT></body> +</html>
Added: trunk/docs/manual/LegalInfo.html ============================================================================== --- (empty file) +++ trunk/docs/manual/LegalInfo.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,42 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Legal Information</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H3 class=unnumbered><FONT face=Arial>Graphic-Forms +Programming Reference (version 0.6)</FONT> </H3> +<P>Copyright � 2006, Jack D. Unrue <jdunrue at gmail.com> <BR></P> +<BLOCKQUOTE>Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + <P>1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. </P> + <P>2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. </P> + <P>3. Neither the names of the authors nor the names of its contributors may + be used to endorse or promote products derived from this software without + specific prior written permission. </P> + <P><SPAN class=sc> THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS AND CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</SPAN> + </P></BLOCKQUOTE> +<H4 class=section><FONT face=Arial>Trademarks</FONT></H4> +<P><FONT face=Arial size=2>Windows� is a registered +trademark of Microsoft Corporation. LispWorks is a trademark of LispWorks Ltd. +All other trademarks used are owned by their respective owners.</FONT> + + </P> +<P> </P></body> +</html>
Added: trunk/docs/manual/MiscellaneousTopics.html ============================================================================== --- (empty file) +++ trunk/docs/manual/MiscellaneousTopics.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,14 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Miscellaneous Topics</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<P><FONT face=Arial size=2>This chapter contains discussion +of various topics germane to Windows programming with Graphic-Forms. </FONT></P> +<P> </P></body> +</html>
Added: trunk/docs/manual/Prerequisites.html ============================================================================== --- (empty file) +++ trunk/docs/manual/Prerequisites.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Prerequisites</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4><FONT face=Arial>Supported Common Lisp +Implementations</FONT> </H4> +<UL> + <LI><FONT face="Arial" size =2>CLISP 2.38 or + later </FONT> + <LI><FONT face="Arial" size =2>LispWorks 4.4.6 + </FONT> + <LI><FONT face="Arial" size =2>SBCL 0.9.15 + </FONT> <A href="Footnotes.html"><FONT face="Arial" size + =2>[1]</FONT></A><FONT face=Arial size=2> </FONT> </LI></UL> +<H4 class=section><FONT face=Arial>Supported Windows Versions</FONT></H4> +<UL> + <LI><FONT face="Arial" size =2>XP SP2 </FONT> + <LI><FONT face="Arial" size =2>Vista </FONT> <A href="Footnotes.html"><FONT + face="Arial" size =2>[2]</FONT></A><FONT face=Arial size=2> </FONT> </LI></UL> +<H4><FONT face=Arial> Required Libraries (downloaded +separately)</FONT> </H4><FONT +face=Arial size=2> +<DL> + <DT><CODE><FONT size=3>ASDF</FONT></CODE> + <DD><A + href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/cclan/asdf%22%3Ehttp://cvs.so...</A><BR><EM>Note that ASDF is bundled with + SBCL. + </EM> + <DD><BR> + <DT><CODE><FONT size=3>CFFI</FONT></CODE> + <DD><A + href="http://common-lisp.net/project/cffi%22%3Ehttp://common-lisp.net/project/cffi</A> + <DD><BR> + <DT><CODE><FONT size=3>Closer to MOP</FONT></CODE> + <DD><A + href="http://common-lisp.net/project/closer/downloads.html%22%3Ehttp://common-lisp...</A> + <DD><BR> + <DT><CODE><FONT size=3>lw-compat</FONT></CODE> + <DD><A + href="http://common-lisp.net/project/closer/downloads.html%22%3Ehttp://common-lisp...</A> + <DD> </DD></DL></FONT> +<H4><FONT face=Arial>Required Libraries (bundled with Graphic-Forms)</FONT> +</H4><FONT face=Arial size=2> +<DL> + <DT><CODE><FONT size=3>Practical Common Lisp Chapter08 and + Chapter24</FONT></CODE> + <DD><A + href="http://www.gigamonkeys.com/book/practicals-1.0.3.tar.gz%22%3Ehttp://www.giga...</A> + <DD><BR> + <DT><CODE><FONT size=3>lisp-unit</FONT></CODE></DT> + <DD><CODE></CODE></FONT><A + href="http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html...<FONT face=Arial + size=2>http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html</FONT></A> + </DD></DL> +<H4><FONT face=Arial>Optional Libraries (downloaded +separately)</FONT> </H4><FONT +face=Arial size=2> +<DL> + <DT><CODE><FONT size=3>ImageMagick</FONT></CODE> + <DD><A + href="http://imagemagick.org/script/binary-releases.php#windows%22%3Ehttp://imagem...</A><BR><EM>Install the Q16 version and push + the symbol :load-imagemagick-plugin onto *features* before executing ASDF. + + </EM> </DD></DL></FONT> +<H4 class=section><FONT face=Arial> +Building</FONT></H4> +<P><FONT face=Arial size=2>Please see the <CODE><FONT size=3>README.txt</FONT></CODE> file included in +the distribution for instructions on how to load the ASDF system, run unit-tests, +and demo programs. </FONT> + + </P> +<P> </P></body> +</html>
Added: trunk/docs/manual/Support.html ============================================================================== --- (empty file) +++ trunk/docs/manual/Support.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Support and Feedback</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4 class=subsection><FONT face=Arial>Mailing Lists and Bug +Reports</FONT></H4><FONT size=2 > +<P><FONT face=Arial>Announcements mailing list: <BR></FONT><A +href="http://www.common-lisp.net/mailman/listinfo/graphic-forms-announce%22%3E<FONT +face=Arial>http://www.common-lisp.net/mailman/listinfo/graphic-forms-announce</FONT></A><FONT +face=Arial> </FONT> +</P> +<P><FONT face=Arial> Developer +mailing list: <BR></FONT><A +href="http://www.common-lisp.net/mailman/listinfo/graphic-forms-devel%22%3E<FONT +face=Arial>http://www.common-lisp.net/mailman/listinfo/graphic-forms-devel</FONT></A><FONT +face=Arial> </FONT> +</P> +<P><FONT face=Arial> Source control mailing list: <BR></FONT><A +href="http://www.common-lisp.net/mailman/listinfo/graphic-forms-cvs%22%3E<FONT +face=Arial>http://www.common-lisp.net/mailman/listinfo/graphic-forms-cvs</FONT></A><FONT +face=Arial> </FONT> +</P> +<P><FONT face=Arial>The bug tracking system: <BR></FONT><A +href="http://sourceforge.net/tracker/?group_id=163034&atid=826145%22%3E<FONT +face=Arial>http://sourceforge.net/tracker/?group_id=163034&atid=826145</FONT></A><FONT +face=Arial> </FONT> +</P> +<H4 class=subsection><FONT face=Arial>Submitting +Patches</FONT> </H4> +<P><FONT face="Arial" > + Patch tracker:<BR> + </FONT> <A +href="http://sourceforge.net/tracker/?group_id=163034&atid=826147%22%3E<FONT face="Arial" +>http://sourceforge.net/tracker/?group_id=163034&atid=826147</FONT></A><FONT +face=Arial> </FONT></P> +<P> </P> </FONT></body> +</html>
Added: trunk/docs/manual/SystemPackage.html ============================================================================== --- (empty file) +++ trunk/docs/manual/SystemPackage.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,21 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>System Package</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4><FONT face=Arial>Full Package Name</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>graphic-forms.uitoolkit.system</FONT></P> +<H4><FONT face=Arial>Nickname</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>GFS</FONT></P> +<H4><FONT face=Arial>Synopsis</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>The symbols in this package correspond to +system-level functionality, such as foreign function declarations for the Win32 +API. The majority of the symbols herein are not exported, except for a few +fundamental types, conditions, and methods.</FONT></P> +<P> </P></body> +</html>
Added: trunk/docs/manual/TerminologyConventions.html ============================================================================== --- (empty file) +++ trunk/docs/manual/TerminologyConventions.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Terminology Conventions</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body marginwidth="10"> +<P><FONT face=Arial size=2>This section documents +terminology conventions observed in Graphic-Forms. These conventions should be +interpreted with the traditional Common Lisp conventions in mind (some of which +are documented here: </FONT> + + <A +href="http://www.cliki.net/Naming%20conventions%22%3E<FONT face=Arial +size=2>http://www.cliki.net/Naming%20conventions</FONT></A><FONT face=Arial +size=2>).</FONT></P> +<DL> + <DT><SPAN class=option><FONT face="Courier New">accessor + names</FONT></SPAN> + <DD><FONT face=Arial size=2>For clearer identification of accessors, Graphic-Forms uses the suffix +`<SAMP><SPAN class=samp>-of</SPAN></SAMP>' whenever possible.</FONT> <BR> <BR> + <DT><SPAN class=option><FONT + face=Courier>check versus select</FONT> + </SPAN> + <DD><FONT face=Arial size=2>Admittedly, these two concepts are similar. They can be used as verbs and +they both describe a state of being (`<SAMP><SPAN +class=samp>checked</SPAN></SAMP>' and `<SAMP><SPAN +class=samp>selected</SPAN></SAMP>'). Yet they need to remain separate due to the +fact that certain widgets can exist in both states simultaneously, like a +tri-state button, or a table or tree whose items are checkboxes. The choice of +which best describes an action or state amounts to a judgement call. In +Graphic-Forms, the author chooses to use `<SAMP><SPAN +class=samp>select</SPAN></SAMP>' when a user gesture causes a widget to issue +its primary notification event, such as a menu item or button being clicked. +Hence, the verb `<SAMP><SPAN class=samp>select</SPAN></SAMP>' aligns with event-select + function.[</FONT> <A +href="Footnotes.html"><FONT face=Arial size=2>6</FONT></A><FONT + face=Arial size=2>] And so the `<SAMP><SPAN +class=samp>selection</SPAN></SAMP>' state is associated with highlighting of an +item. Graphic-Forms uses `<SAMP><SPAN class=samp>check</SPAN></SAMP>' to +identify an operation that flags or annotates a widget; the `<SAMP><SPAN +class=samp>checked</SPAN></SAMP>' state means being + annotated.</FONT> + <BR> + <BR> + + + <DT><FONT face=Courier>function and method names</FONT> + <DD><FONT face=Arial size=2>Functions and methods should be named using a verb to suggest action. It + may be tempting (especially for former Java programmers) to use the Java + getter/setter naming conventions for accessor-like functions, but the author + prefers `<SAMP><SPAN class=samp>obtain</SPAN></SAMP>' rather than `<SAMP><SPAN + class=samp>get</SPAN></SAMP>', and he prefers <SPAN class=sc>setf</SPAN>able + places to Java-style `<SAMP><SPAN class=samp>put</SPAN></SAMP>' or + `<SAMP><SPAN class=samp>set</SPAN></SAMP>' functions. In the latter case, + where a symbol refers to both an accessor and a <SPAN class=sc>setf</SPAN> + function, the author omits the `<SAMP><SPAN class=samp>obtain</SPAN></SAMP>' + prefix (like size). For status querying functions, the author suggests + following the standard Common Lisp convention of `<SAMP><SPAN + class=samp>availablep</SPAN></SAMP>' or `<SAMP><SPAN + class=samp>some-test-p</SPAN></SAMP>'.</FONT> <BR> <BR> + <DT><FONT face=Courier>macro names</FONT> + <DD><FONT face=Arial size=2>Macro names should be chosen + in a manner consistent with established Common Lisp practice. An exception is + allowed for convenience wrappers around structure accessors (see for example + location).</FONT> + + <BR> + + </DD></DL> +<P> </P></body> +</html>
Added: trunk/docs/manual/WidgetsPackage.html ============================================================================== --- (empty file) +++ trunk/docs/manual/WidgetsPackage.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,20 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Widgets Package</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4><FONT face=Arial>Full Package Name</FONT></H4><FONT face=Arial size=2> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>graphic-forms.uitoolkit.widgets</FONT></P> </FONT> +<H4><FONT face=Arial>Nickname</FONT></H4><FONT face=Arial size=2> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>GFW</FONT></P> +<H4><FONT face=Arial>Synopsis</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>This package contains symbols for user interface +widget classes, event-handling methods, and management functions. This +package and GFG together constitute the bulk of the public API.</FONT></P> +<P> </P></FONT></body> +</html>
Added: trunk/docs/manual/gfs-native-object.html ============================================================================== --- (empty file) +++ trunk/docs/manual/gfs-native-object.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,41 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>native-object</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4><FONT face=Arial > +native-object</FONT></H4> +<P dir=ltr><FONT face=Arial size=2>Class</FONT></P> +<P dir=ltr><FONT face=Arial size=2>Inherits: <EM>none</EM></FONT></P> +<P dir=ltr><FONT face=Arial size=2>Inherited By: image-data-plugin, font, +graphics-context, icon-bundle, image, display, event-source</FONT></P> +<H4 dir=ltr><FONT face=Arial>Synopsis</FONT></H4><FONT size=2 > +<P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>This is the +base class for objects representing a system resource such as a window or device +context.</FONT></FONT></P> +<H4><FONT face=Arial>Slots</FONT></H4><FONT face=Arial size=2><EM> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" +borderColor=#ffffff cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><EM><FONT + size=2> handle</FONT></EM></TD> + <TD><FONT size=2> A Win32 HANDLE or foreign pointer. Applications + should not modify this directly.</FONT></TD></TR></TABLE></P></EM></FONT> +<H4 dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial>Slot Readers</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" borderColor=#ffffff +cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><FONT face=Arial size=2> handle</FONT></TD> + <TD><FONT face=Arial size=2>Returns the Win32 HANDLE or foreign pointer + stored in the <EM>handle</EM> +slot.</FONT></TD></TR></TABLE></P></body> +</html>
Added: trunk/docs/manual/gfs-point.html ============================================================================== --- (empty file) +++ trunk/docs/manual/gfs-point.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>point</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body><FONT face=Arial size=2> +<H4><FONT face=Arial> +point</FONT></H4> +<P>Structure</P> +<H4><FONT face=Arial>Synopsis</FONT></H4><FONT face=Arial size=2> + <P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>This structure represents a point in the Cartesian + plane.</FONT></FONT></P> +<H4><FONT face=Arial>Slots</FONT></H4><FONT face=Arial size=2><EM> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" borderColor=#ffffff +cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><EM><FONT size=2>x</FONT></EM></TD> + <TD><FONT size=2>An integer + specifying the point's X coordinate.</FONT></TD></TR> + <TR> + <TD width="20%"><EM><FONT size=2>y</FONT></EM></TD> + <TD><FONT size=2>An integer + specifying the point's Y +coordinate.</FONT></TD></TR></TABLE></P></EM></FONT> +<H4 dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial>Slot +Accessors</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" borderColor=#ffffff +cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><FONT face=Arial size=2>point-x</FONT></TD> + <TD><FONT face=Arial size=2>Sets or returns the value of the <EM>x</EM> + slot.</FONT></TD></TR> + <TR> + <TD width="20%"><FONT size=2>point-y</FONT></TD> + <TD><FONT size=2>Sets or returns the value of the <EM>y</EM> + slot.</FONT></TD></TR></TABLE></P> </FONT></body> +</html>
Added: trunk/docs/manual/gfs-rectangle.html ============================================================================== --- (empty file) +++ trunk/docs/manual/gfs-rectangle.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>rectangle</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body><FONT face=Arial size=2> +<H4><FONT face=Arial>rectangle</FONT></H4> +<P>Structure</P> +<H4><FONT face=Arial>Synopsis</FONT></H4><FONT face=Arial size=2> + <P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>This + structure represents a rectangle in the Cartesian + plane.</FONT></FONT></P> +<H4><FONT face=Arial>Slots</FONT></H4><FONT face=Arial size=2><EM> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" borderColor=#ffffff +cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><EM><FONT size=2>location</FONT></EM></TD> + <TD><FONT size=2>A <A + href="gfs-point.html">point</A> + object representing the rectangle's upper-left corner.</FONT></TD></TR> + <TR> + <TD width="20%"><EM><FONT size=2>size</FONT></EM></TD> + <TD><FONT size=2>A <A + href="gfs-size.html">size</A> object representing rectangle's width and +height.</FONT></TD></TR></TABLE></P></EM></FONT> +<H4 dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial>Slot +Accessors</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" borderColor=#ffffff +cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><FONT face=Arial size=2>rectangle-location</FONT></TD> + <TD><FONT face=Arial size=2>Sets or returns the value of the <EM>location</EM> + slot.</FONT></TD></TR> + <TR> + <TD width="20%"><FONT size=2>rectangle-size</FONT></TD> + <TD><FONT size=2>Sets or returns the value of the <EM>size</EM> + slot.</FONT></TD></TR></TABLE></P> </FONT> +<H4><FONT face=Arial>See Also</FONT></H4><FONT face=Arial size=2> +<BLOCKQUOTE dir=ltr style="MARGIN-RIGHT: 0px"> + <P><A href="gfs-point.html">point</A>, <A href="gfs-size.html">size</A> </P> + <P></FONT> </P></BLOCKQUOTE></body> +</html>
Added: trunk/docs/manual/gfs-size.html ============================================================================== --- (empty file) +++ trunk/docs/manual/gfs-size.html Mon Oct 2 10:54:59 2006 @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>size</title> +<meta name="GENERATOR" content="WinCHM"> +<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> + +</head> + +<body> +<H4><FONT face=Arial>size</FONT></H4><FONT face=Arial size=2> + <P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>Structure</FONT></P> +<H4><FONT face=Arial>Synopsis</FONT></H4><FONT face=Arial size=2> + <P dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial size=2>This structure represents a 2-dimensional + area.</FONT></FONT></P> +<H4><FONT face=Arial>Slots</FONT></H4><FONT face=Arial size=2><EM> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" borderColor=#ffffff +cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><EM><FONT size=2>height</FONT></EM></TD> + <TD><FONT size=2>An integer + specifying the height of the area.</FONT></TD></TR> + <TR> + <TD width="20%"><EM><FONT size=2>width</FONT></EM></TD> + <TD><FONT size=2>An integer + specifying the width of the +area.</FONT></TD></TR></TABLE></P></EM></FONT> +<H4 dir=ltr style="MARGIN-RIGHT: 0px"><FONT face=Arial>Slot +Accessors</FONT></H4> +<P dir=ltr style="MARGIN-RIGHT: 0px"> +<TABLE style="WIDTH: 100%; BORDER-COLLAPSE: collapse" borderColor=#ffffff +cellSpacing=0 cellPadding=2 width="100%" border=1> + + <TR> + <TD width="20%"><FONT face=Arial size=2>size-height</FONT></TD> + <TD><FONT face=Arial size=2>Sets or returns the value of + the <EM>height</EM> slot.</FONT></TD></TR> + <TR> + <TD width="20%"><FONT size=2>size-width</FONT></TD> + <TD><FONT size=2>Sets or returns the value of the <EM>width</EM> + slot.</FONT></TD></TR></TABLE></P> </FONT></body> +</html>