notgne2/tuxpaint-pencil-sharpener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

get_description() gets mode, so tools can provide diff. instructions.

Browse source
This commit is contained in:
William Kendrick 2008-07-09 04:37:08 +00:00
parent c9dfc4d1d8
commit 2e5508842f
32 changed files with 102 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

19
magic/docs/README.txt
View file

@ -218,16 +218,23 @@ Interfaces
Note: Called once for each Magic tool your plugin claims to
contain (by your "get_tool_count()").
* char * get_description(magic_api * api, int which)
This should return a string containing the description of a
magic tool. This will appear as a help tip, explained by Tux the
Penguin, within Tux Paint.
* char * get_description(magic_api * api, int which, int mode)
This should return a string containing the description of how to
use a particular magic tool. This will appear as a help tip,
explained by Tux the Penguin, within Tux Paint.
Tux Paint will free() the string upon exit, so you should wrap
it in a C strdup() call.
Note: Called once for each Magic tool your plugin claims to
contain (by your "get_tool_count()").
Note: For each Magic tool your plugin claims to contain
(reported by your "get_tool_count()" function), this function
will be called for each mode the tool claims to support
(reported by your "modes()" function).
In other words, if your plugin contains two tools, one which
works in paint mode only, and the other that works in both paint
mode and full-image mode, your plugin's "get_description()" will
be called three times.
* int requires_colors(magic_api * api, int which)
Return a '1' if the 'Magic' tool accepts colors (the 'Colors'

16
magic/docs/html/README.html
View file

@ -284,16 +284,24 @@ then the names of your functions must begin with "<code><b>zoom_</b></code>"
<br>
<li><code><b>char * get_description(magic_api&nbsp;*&nbsp;api,
int&nbsp;which)</b></code><br>
This should return a string containing the description of a magic tool.
int&nbsp;which, int&nbsp;mode)</b></code><br>
This should return a string containing the description of how to
use a particular magic tool.
This will appear as a help tip, explained by Tux the Penguin, within
Tux&nbsp;Paint.<br>
<br>
Tux Paint will <code>free()</code> the string upon exit, so you should
wrap it in a C <code>strdup()</code> call.<br>
<br>
<b>Note:</b> Called once for each Magic tool your plugin claims to
contain (by your "<code>get_tool_count()</code>").<br>
<b>Note:</b> For each Magic tool your plugin claims to
contain (reported by your "<code>get_tool_count()</code>" function),
this function will be called for each mode the tool claims to support
(reported by your "<code>modes()</code>" function).<br>
<br>
In other words, if your plugin contains two tools, one which works in
paint mode only, and the other that works in both paint mode and
full-image mode, your plugin's "<code>get_description()</code>" will be
called three times.<br>
<br>
<li><code><b>int requires_colors(magic_api&nbsp;*&nbsp;api,