pidgin/gtksession.h

   1 /* pidgin
   2  *
   3  * Pidgin 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 _PIDGINSESSION_H_
  23 #define _PIDGINSESSION_H_
  24 /**
  25  * SECTION:gtksession
  26  * @section_id: pidgin-gtksession
  27  * @short_description: <filename>gtksession.h</filename>
  28  * @title: X Windows Session Management
  29  */
  30
  31 G_BEGIN_DECLS
  32
  33 /**************************************************************************/
  34 /* X Windows session subsystem                                            */
  35 /**************************************************************************/
  36
  37 /**
  38  * pidgin_session_init:
  39  * @argv0:       The first argument passed into the program.  This
  40  *                    will be the name of the executable, e.g. 'purple'
  41  * @previous_id: An optional session ID to use.  This can be NULL.
  42  * @config_dir:  The path to the configuration directory used by
  43  *                    this instance of this program, e.g. '/home/user/.purple'
  44  *
  45  * Register this instance of Pidgin with the user's current session
  46  * manager.
  47  */
  48 void pidgin_session_init(gchar *argv0, gchar *previous_id, gchar *config_dir);
  49
  50 /**
  51  * pidgin_session_end:
  52  *
  53  * Unregister this instance of Pidgin with the user's current session
  54  * manager.
  55  */
  56 void pidgin_session_end(void);
  57
  58 G_END_DECLS
  59
  60 #endif /* _PIDGINSESSION_H_ */