[Rezilla-commits] RezillaHelp/English.lproj/RezillaHelp 1.html, 1.26, 1.27 80.html, 1.2, 1.3
Brought to you by:
bdesgraupes
Menu
▾
▴
[Rezilla-commits] RezillaHelp/English.lproj/RezillaHelp 1.html, 1.26, 1.27 80.html, 1.2, 1.3
|
From: Bernard D. <bde...@us...> - 2006-11-25 12:04:02
|
Update of /cvsroot/rezilla/RezillaHelp/English.lproj/RezillaHelp In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv31279 Modified Files: 1.html 80.html Log Message: Ultimate 1.1 corrs Index: 1.html =================================================================== RCS file: /cvsroot/rezilla/RezillaHelp/English.lproj/RezillaHelp/1.html,v retrieving revision 1.26 retrieving revision 1.27 diff -u -d -r1.26 -r1.27 --- 1.html 1 Nov 2006 16:57:02 -0000 1.26 +++ 1.html 25 Nov 2006 12:03:59 -0000 1.27 @@ -3,6 +3,7 @@ <TITLE>Introduction</TITLE> <META HTTP-EQUIV="content-type" CONTENT="text/html;charset=iso-8859-1"> <META NAME="generator" CONTENT="Aida Mode"> +<META HTTP-EQUIV="Content-Language" CONTENT="en-GB"> <META NAME="keywords" CONTENT="resources, forks, Mac OS"> </HEAD> <BODY> @@ -13,7 +14,7 @@ developed as an <I>Open Source</I> project coming with a GNU Public License. The source code is currently hosted on the <A HREF="http://sourceforge.net/projects/rezilla">SourceForge site.</A> -<P> This file documents version 1.1rc1 of Rezilla. +<P> This file documents version 1.1 of Rezilla. </I></P></BLOCKQUOTE><HR><P> </BODY> Index: 80.html =================================================================== RCS file: /cvsroot/rezilla/RezillaHelp/English.lproj/RezillaHelp/80.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- 80.html 1 Nov 2006 16:57:03 -0000 1.2 +++ 80.html 25 Nov 2006 12:03:59 -0000 1.3 @@ -75,22 +75,33 @@ requests: the plugin could ask Rezilla to provide one or several menus for instance. The plugin can also attribute a <I>RezPlugRef</I>, a pointer to private data which Rezilla will pass back in all its calls to interface -functions.<P> <LI> after Rezilla receives acceptance and requests from the plugin, it -invokes the <I>EditResource</I> function. Through this function the -plugin receives a <I>RezHostInfo</I> structure filled by Rezilla and -containing basic information such as a <I>WindowRef</I> for the editing window, -the <I>MenuRef</I> pointers in case the plugin needs some menus, etc. -</OL><P>At this point the plugin can do its job to edit the resource. It can -populate the window with controls and graphic elements, install CarbonEvents on these controls, -etc. Note though that the plugin is not obliged to use CarbonEvents; the basic user actions -are passed to it by Rezilla with an EventRecord via the following -functions declared in the interface: +functions.<P> <LI> after Rezilla receives acceptance and requests from the plugin, it +invokes the <I>EditResource</I> function. Through this function the plugin +receives a <I>RezHostInfo</I> structure filled by Rezilla and containing +basic information such as a <I>WindowRef</I> for the editing window, the +<I>MenuRef</I> pointers in case the plugin needs some menus, etc. +</OL><P>At this point the plugin can do its job to edit the resource. It can +populate the window with controls and graphic elements, install +CarbonEvents on these controls if necessary, etc. The window provided by +Rezilla is constructed in compositing mode: this makes the HIView drawing +model fully available.<P>Note though that the plugin is not obliged to use CarbonEvents; the basic +user actions are passed to it by Rezilla with an EventRecord via the +following functions declared in the interface: <I>HandleMenu, HandleClick, HandleKeyDown</I> and <I>HandleCommand</I>.<P>When it is time to save the modifications made in a resource (for instance -when the user clicks on the <I>Save</I> button or attempts to close the window), -Rezilla invokes the <I>ReturnResource</I> function so that the plugin -returns the new data and then the <I>CleanUp</I> function so that it can -perform any post editing tasks, like releasing allocated memory for -instance.<P><H4><A NAME="M116"></A>Plugin requests</H4><P>This section gives more details about the requests made by the plugin in +when the user clicks on the <I>Save</I> button or attempts to close the +window), Rezilla invokes the <I>ReturnResource</I> function so that the +plugin returns the new data and then the <I>CleanUp</I> function so that +it terminates its editing session. +<UL> + <LI> the <I>ReturnResource</I> function returns a handle to the data. It +also has a boolean argument named <I>releaseIt</I> to tell Rezilla who is +the owner of this handle and should dispose of it. If <I>releaseIt</I> is +set to true, Rezilla will dispose of the handle after the resource is +saved. Otherwise the plugin assumes ownership.<P> <LI> when the <I>CleanUp</I> function is called, the plugin should perform +any post editing tasks, release allocated memory, etc.<P></UL><P>If the user clicks on the <I>Revert</I> button (if there is one!), Rezilla +invokes the <I>RevertResource</I> function: the data to revert to are +provided in the <I>inDataH</I> argument, so the plugin does not have to +worry about keeping a copy of the original data.<P><H4><A NAME="M116"></A>Plugin requests</H4><P>This section gives more details about the requests made by the plugin in the <I>AcceptResource</I> function. The <I>RezPlugInfo</I> structure is defined like this: <PRE> typedef struct RezPlugInfo { @@ -139,10 +150,13 @@ | kPluginSupportClear) } </PRE><P>The <I>winbounds</I> member is a Rect structure indicating the position -and dimension of the editing window. Rezilla always provides an editing -window which can be equiped with some basic controls such as a <I>Save</I> button, -a <I>Cancel</I> button etc. The plugin does not have to track these controls: they -are managed by the main application. The plugin just decides, using the +and dimension of the editing window: it is in global coordinates and +corresponds to the entire structure of the window, that is to say the +dimensions that will be passed to the <I>CreateWindow</I> toolbox +function. Rezilla always provides an editing window which can be equiped +with some basic controls such as a <I>Save</I> button, a <I>Cancel</I> +button etc. The plugin does not have to track these controls: they are +managed by the main application. The plugin just decides, using the appropriate flags, which controls should be present in the editing window. For instance, add the <I>kPluginEditorHasRevertButton</I> flag to the attributes to get a <I>Revert</I> button.<P>The <I>menucount</I> member indicates how many menus are needed by the @@ -225,6 +239,7 @@ plugErr_RevertResourceFailed, plugErr_CantResizeWindow, plugErr_CantHandleMenuCommand, + plugErr_CantEditEmptyResource, plugErr_LastError } </PRE><P> |
