Added doxygen documentation. Now we have to update the comments in all the files. See aide.h and button.h for some examples. Documentation is regenerated by "doxygen Doxyfile" in the root directory

git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@665 416bcca6-2ee7-4201-b75f-2eb2f807beb1
This commit is contained in:
Adrien Destugues
2009-03-06 21:05:05 +00:00
parent b5a1fadbe0
commit 5f50f7bc22
310 changed files with 117783 additions and 2 deletions

View File

@@ -0,0 +1,112 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>GrafX2: windows.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
</ul>
</div>
<h1>windows.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Grafx2 - The Ultimate 256-color bitmap paint program</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright 2007-2008 Adrien Destugues</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright 1996-2001 Sunset Design (Guillaume Dorme &amp; Karl Maritaud)</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> Grafx2 is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU General Public License</span>
<a name="l00008"></a>00008 <span class="comment"> as published by the Free Software Foundation; version 2</span>
<a name="l00009"></a>00009 <span class="comment"> of the License.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> Grafx2 is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> along with Grafx2; if not, see &lt;http://www.gnu.org/licenses/&gt; or</span>
<a name="l00018"></a>00018 <span class="comment"> write to the Free Software Foundation, Inc.,</span>
<a name="l00019"></a>00019 <span class="comment"> 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __WINDOWS_H_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __WINDOWS_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "struct.h"</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="keywordtype">void</span> Afficher_curseur(<span class="keywordtype">void</span>);
<a name="l00028"></a>00028 <span class="keywordtype">void</span> Effacer_curseur(<span class="keywordtype">void</span>);
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keywordtype">void</span> Remapper_ecran_apres_changement_couleurs_menu(<span class="keywordtype">void</span>);
<a name="l00031"></a>00031 <span class="keywordtype">void</span> Calculer_couleurs_menu_optimales(<span class="keyword">struct</span> Composantes * Palette);
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keywordtype">void</span> Recadrer_ecran_par_rapport_au_zoom(<span class="keywordtype">void</span>);
<a name="l00034"></a>00034 <span class="keywordtype">void</span> Calculer_split(<span class="keywordtype">void</span>);
<a name="l00035"></a>00035 <span class="keywordtype">void</span> Calculer_donnees_loupe(<span class="keywordtype">void</span>);
<a name="l00036"></a>00036 <span class="keywordtype">void</span> Calculer_limites(<span class="keywordtype">void</span>);
<a name="l00037"></a>00037 <span class="keywordtype">void</span> Calculer_coordonnees_pinceau(<span class="keywordtype">void</span>);
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keywordtype">void</span> Pixel_dans_barre_d_outil(word X,word Y,byte Couleur);
<a name="l00040"></a>00040 <span class="keywordtype">void</span> Pixel_dans_fenetre(word X,word Y,byte Couleur);
<a name="l00041"></a>00041 <span class="keywordtype">void</span> Encadrer_couleur_menu(byte Couleur);
<a name="l00042"></a>00042 <span class="keywordtype">void</span> Afficher_palette_du_menu(<span class="keywordtype">void</span>);
<a name="l00043"></a>00043 <span class="keywordtype">void</span> Afficher_menu(<span class="keywordtype">void</span>);
<a name="l00044"></a>00044 <span class="keywordtype">void</span> Recadrer_palette(<span class="keywordtype">void</span>);
<a name="l00045"></a>00045 <span class="keywordtype">void</span> Changer_cellules_palette(<span class="keywordtype">void</span>);
<a name="l00046"></a>00046 <span class="keywordtype">int</span> Couleur_palette(<span class="keywordtype">void</span>);
<a name="l00047"></a>00047 word Palette_Cells_X(<span class="keywordtype">void</span>);
<a name="l00048"></a>00048 word Palette_Cells_Y(<span class="keywordtype">void</span>);
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keywordtype">void</span> Print_general(<span class="keywordtype">short</span> X,<span class="keywordtype">short</span> Y,<span class="keyword">const</span> <span class="keywordtype">char</span> * Chaine,byte Couleur_texte,byte Couleur_fond);
<a name="l00051"></a>00051 <span class="keywordtype">void</span> Print_dans_fenetre(<span class="keywordtype">short</span> X,<span class="keywordtype">short</span> Y,<span class="keyword">const</span> <span class="keywordtype">char</span> * Chaine,byte Couleur_texte,byte Couleur_fond);
<a name="l00052"></a>00052 <span class="keywordtype">void</span> Print_dans_fenetre_limite(<span class="keywordtype">short</span> X,<span class="keywordtype">short</span> Y,<span class="keyword">const</span> <span class="keywordtype">char</span> * Chaine,byte Taille,byte Couleur_texte,byte Couleur_fond);
<a name="l00053"></a>00053 <span class="keywordtype">void</span> Print_char_dans_fenetre(<span class="keywordtype">short</span> Pos_X,<span class="keywordtype">short</span> Pos_Y,<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Caractere,byte Couleur_texte,byte Couleur_fond);
<a name="l00054"></a>00054 <span class="keywordtype">void</span> Print_char_transparent_dans_fenetre(<span class="keywordtype">short</span> Pos_X,<span class="keywordtype">short</span> Pos_Y,<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Caractere,byte Couleur);
<a name="l00055"></a>00055 <span class="keywordtype">void</span> Print_dans_menu(<span class="keyword">const</span> <span class="keywordtype">char</span> * Chaine, <span class="keywordtype">short</span> Position);
<a name="l00056"></a>00056 <span class="keywordtype">void</span> Print_coordonnees(<span class="keywordtype">void</span>);
<a name="l00057"></a>00057 <span class="keywordtype">void</span> Print_nom_fichier(<span class="keywordtype">void</span>);
<a name="l00058"></a>00058 <span class="keywordtype">void</span> Print_compteur(<span class="keywordtype">short</span> X,<span class="keywordtype">short</span> Y,<span class="keyword">const</span> <span class="keywordtype">char</span> * Chaine,byte Couleur_texte,byte Couleur_fond);
<a name="l00059"></a>00059
<a name="l00060"></a>00060 byte Demande_de_confirmation(<span class="keywordtype">char</span> * Message);
<a name="l00061"></a>00061 <span class="keywordtype">void</span> Warning_message(<span class="keywordtype">char</span> * Message);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keywordtype">void</span> Afficher_limites_de_l_image(<span class="keywordtype">void</span>);
<a name="l00064"></a>00064 <span class="keywordtype">void</span> Afficher_ecran(<span class="keywordtype">void</span>);
<a name="l00065"></a>00065 <span class="keywordtype">void</span> Fenetre_Afficher_cadre_general(word Pos_X,word Pos_Y,word Largeur,word Hauteur,
<a name="l00066"></a>00066 byte Couleur_HG,byte Couleur_BD,byte Couleur_S,byte Couleur_CHG,byte Couleur_CBD);
<a name="l00067"></a>00067 <span class="keywordtype">void</span> Fenetre_Afficher_cadre_mono(word Pos_X,word Pos_Y,word Largeur,word Hauteur,byte Couleur);
<a name="l00068"></a>00068 <span class="keywordtype">void</span> Fenetre_Afficher_cadre_creux(word Pos_X,word Pos_Y,word Largeur,word Hauteur);
<a name="l00069"></a>00069 <span class="keywordtype">void</span> Fenetre_Afficher_cadre_bombe(word Pos_X,word Pos_Y,word Largeur,word Hauteur);
<a name="l00070"></a>00070 <span class="keywordtype">void</span> Fenetre_Afficher_cadre(word Pos_X,word Pos_Y,word Largeur,word Hauteur);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keywordtype">void</span> Afficher_sprite_dans_menu(<span class="keywordtype">int</span> Numero_bouton,<span class="keywordtype">int</span> Numero_sprite);
<a name="l00073"></a>00073 <span class="keywordtype">void</span> Afficher_pinceau_dans_menu(<span class="keywordtype">void</span>);
<a name="l00074"></a>00074 <span class="keywordtype">void</span> Afficher_pinceau_dans_fenetre(word X,word Y,<span class="keywordtype">int</span> Numero);
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordtype">void</span> Dessiner_zigouigoui(word X,word Y, byte Couleur, <span class="keywordtype">short</span> Sens);
<a name="l00077"></a>00077 <span class="keywordtype">void</span> Bloc_degrade_dans_fenetre(word Pos_X,word Pos_Y,word Debut_block,word Fin_block);
<a name="l00078"></a>00078 <span class="keywordtype">void</span> Fenetre_Afficher_sprite_drive(word Pos_X,word Pos_Y,byte Type);
<a name="l00079"></a>00079
<a name="l00080"></a>00080 byte Meilleure_couleur(byte Rouge,byte Vert,byte Bleu);
<a name="l00081"></a>00081 byte Meilleure_couleur_sans_exclusion(byte Rouge,byte Vert,byte Bleu);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordtype">void</span> Ligne_horizontale_XOR_Zoom(<span class="keywordtype">short</span> Pos_X, <span class="keywordtype">short</span> Pos_Y, <span class="keywordtype">short</span> Largeur);
<a name="l00084"></a>00084 <span class="keywordtype">void</span> Ligne_verticale_XOR_Zoom(<span class="keywordtype">short</span> Pos_X, <span class="keywordtype">short</span> Pos_Y, <span class="keywordtype">short</span> Hauteur);
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 16:29:55 2009 for GrafX2 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>