finch/finch.h

   1 /* finch
   2  *
   3  * Finch is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef _FINCH_H_
  23 #define _FINCH_H_
  24
  25 /**
  26  * SECTION:finch
  27  * @section_id: finch-finch
  28  * @short_description: <filename>finch.h</filename>
  29  * @title: UI Definitions and Includes
  30  */
  31
  32 #include <glib.h>
  33
  34 #define FINCH_UI "gnt-purple"
  35
  36 #define FINCH_PREFS_ROOT "/finch"
  37
  38 /**
  39  * finch_start:
  40  * @argc: Address of the argc parameter of your main() function (or 0 if argv
  41  *        is %NULL). This will be changed if any arguments were handled.
  42  * @argv: Address of the argv parameter of main(), or %NULL. Any options
  43  *        understood by Finch are stripped before return.
  44  *
  45  * Start finch with the given command line arguments.
  46  */
  47 gboolean finch_start(int *argc, char ***argv);
  48
  49 #endif