This replaces ChangeLog.API. Much of the boilerplate text is from GTK,
though it's been modified to only contain information applicable to
this project.
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndefGNT_H
#defineGNT_H
/**
* SECTION:gnt
* @section_id: libgnt-gnt
* @title: General
* @short_description: General API for managing GNT
*/
#include<glib.h>
#ifdef_WIN32
#undefKEY_EVENT
#endif
#defineNCURSES_WIDECHAR@NCURSES_WIDECHAR@
#include<@NCURSES_HEADER@>
#include"gntwidget.h"
#include"gntclipboard.h"
#include"gntcolors.h"
#include"gntkeys.h"
/**
* gnt_init:
*
* Initialize GNT.
*/
voidgnt_init(void);
/**
* gnt_set_config_dir:
* @config_dir: the path to a configuration directory, may be %NULL.
*
* Change directory to store gnt configuration files (default is ~).
*
* You have to call this before #gnt_init. You might want to call this
* with %NULL, to free the resources, but not before a call to #gnt_quit.
*
* Since: 3.0.0
*/
voidgnt_set_config_dir(constgchar*config_dir);
/**
* gnt_main:
*
* Start running the mainloop for gnt.
*/
voidgnt_main(void);
/**
* gnt_ascii_only:
*
* Check whether the terminal is capable of UTF8 display.
*
* Returns: %FALSE if the terminal is capable of drawing UTF-8, %TRUE otherwise.
*/
gbooleangnt_ascii_only(void);
/**
* gnt_window_present:
* @window: The window the present.
*
* Present a window. If the event was triggered because of user interaction,
* the window is moved to the foreground. Otherwise, the Urgent hint is set.