input_buffer.h File Reference

Input Buffer Subsystem. More...

#include <gtk/gtk.h>

Go to the source code of this file.

Functions
gboolean	init_input_buffer (void)
	Initialize the input buffer for interaction.
void	free_input_buffer (void)
	Frees the input buffer and all associated allocations.
void	input_process_key (int key)
	Dispatches a character to be handled by the input subsystem.
void	clear_input (void)
	Clears any input from the buffer.
gchar *	get_input_buffer (void)
	Gets a pointer to the input buffer.
void	set_input_buffer (gchar *str)
	Sets the input buffer, overwriting anything that already exists.
void	add_to_input_buffer (gchar c)
	Adds a single character to the end of the input buffer.

---

Detailed Description

Input Buffer Subsystem.

Copyright (C) 2005, Ike Gingerich <ike_@users.sourceforge.net>

This program 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

---

Function Documentation

void add_to_input_buffer (  gchar  c  )

Adds a single character to the end of the input buffer. Parameters: c  The character to append to the input buffer.

gchar* get_input_buffer (  void   )

Gets a pointer to the input buffer. Returns: Returns a pointer to the input buffer.

gboolean init_input_buffer (  void   )

Initialize the input buffer for interaction. Returns: TRUE on success FALSE othewise.

void input_process_key (  int  key  )

Dispatches a character to be handled by the input subsystem. Parameters: key  The key in the form of an integer key-code returned from Curses getch()

void set_input_buffer (  gchar *  str  )

Sets the input buffer, overwriting anything that already exists. Parameters: str  The new contents of the input buffer.

---