fruitjam-doom/textscreen/txt_button.h
Simon Howard 7684ddcfd8 Clean up file headers.
This change rewrites and simplifies the copyright headers at the top
of all source files:

 * Remove "Emacs style mode select" line; this line was included in
   the headers for the originally released source files and appears
   to be to set the file type for old versions of Emacs. I'm not sure
   entirely why it was required but I don't think it is any more.
 * Remove "You should have received a copy of..." text from copyright
   header. This refers to the old 59 Temple Place address where the
   FSF headquarters used to be located and is no longer correct.
   Rather than change to the new address, just remove the paragraph
   as it is superfluous anyway. This fixes #311.
 * Remove ---- separator lines so that the file headers are barer
   and more simplified.
2014-05-05 00:20:54 -04:00

74 lines
1.8 KiB
C

//
// Copyright(C) 2005-2014 Simon Howard
//
// 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.
//
#ifndef TXT_BUTTON_H
#define TXT_BUTTON_H
/**
* @file txt_button.h
*
* Button widget.
*/
/**
* Button widget.
*
* A button is a widget that can be selected to perform some action.
* When a button is pressed, it emits the "pressed" signal.
*/
typedef struct txt_button_s txt_button_t;
#include "txt_widget.h"
struct txt_button_s
{
txt_widget_t widget;
char *label;
};
/**
* Create a new button widget.
*
* @param label The label to use on the new button.
* @return Pointer to the new button widget.
*/
txt_button_t *TXT_NewButton(char *label);
/**
* Create a new button widget, binding the "pressed" signal to a
* specified callback function.
*
* @param label The label to use on the new button.
* @param func The callback function to invoke.
* @param user_data User-specified pointer to pass to the callback.
* @return Pointer to the new button widget.
*/
txt_button_t *TXT_NewButton2(char *label, TxtWidgetSignalFunc func,
void *user_data);
/**
* Change the label used on a button.
*
* @param button The button.
* @param label The new label.
*/
void TXT_SetButtonLabel(txt_button_t *button, char *label);
#endif /* #ifndef TXT_BUTTON_H */