scp-fs2open/fs2open.github.com
1
0 Fork 0
mirror of https://github.com/scp-fs2open/fs2open.github.com.git synced 2026-11-10 04:31:34 -10:00
Code Issues Packages Projects Releases 1 Wiki Activity
Files
de286131663b55eda57d1ace5ebf4e51ac95588d
fs2open.github.com/code/ui/button.cpp
T

649 lines
16 KiB
C++
Raw Blame History

/*
* Copyright (C) Volition, Inc. 1999. All rights reserved.
*
* All source code herein is the property of Volition, Inc. You may not sell
* or otherwise commercially exploit the source or things you created based on the
* source.
*
*/
/*
* $Logfile: /Freespace2/code/UI/BUTTON.cpp $
* $Revision: 2.4.2.1 $
* $Date: 2006-09-08 06:14:44 $
* $Author: taylor $
*
* Code for pushbuttons
*
* $Log: not supported by cvs2svn $
* Revision 2.4 2005/05/12 17:49:17 taylor
* use vm_malloc(), vm_free(), vm_realloc(), vm_strdup() rather than system named macros
* fixes various problems and is past time to make the switch
*
* Revision 2.3 2005/01/31 23:27:55 taylor
* merge with Linux/OSX tree - p0131-2
*
* Revision 2.2 2003/11/11 02:15:42 Goober5000
* ubercommit - basically spelling and language fixes with some additional
* warnings disabled
* --Goober5000
*
* Revision 2.1 2002/08/01 01:41:10 penguin
* The big include file move
*
* Revision 2.0 2002/06/03 04:02:29 penguin
* Warpcore CVS sync
*
* Revision 1.1 2002/05/02 18:03:13 mharris
* Initial checkin - converted filenames and includes to lower case
*
*
* 9 8/16/99 9:45a Jefff
* changes to cursor management to allow a 2nd temporary cursor
*
* 8 8/05/99 2:44p Jefff
* added disabled callback to UI_BUTTON
*
* 7 5/21/99 6:45p Dave
* Sped up ui loading a bit. Sped up localization disk access stuff. Multi
* start game screen, multi password, and multi pxo-help screen.
*
* 6 2/11/99 3:08p Dave
* PXO refresh button. Very preliminary squad war support.
*
* 5 12/21/98 9:05a Dave
* Changed UI code so it doesn't require 3 bitmaps for a 3 state button.
*
* 4 12/02/98 5:47p Dave
* Put in interface xstr code. Converted barracks screen to new format.
*
* 3 10/13/98 9:29a Dave
* Started neatening up freespace.h. Many variables renamed and
* reorganized. Added AlphaColors.[h,cpp]
*
* 2 10/07/98 10:54a Dave
* Initial checkin.
*
* 1 10/07/98 10:51a Dave
*
* 42 5/12/98 11:59p Dave
* Put in some more functionality for Parallax Online.
*
* 41 5/11/98 5:29p Hoffoss
* Added mouse button mapped to joystick button support.
*
* 40 5/03/98 1:55a Lawrance
* Add function call that forces button code to skip first callback for
* highlighing
*
* 39 4/22/98 5:19p Lawrance
* only strdup strings that are not zero length
*
* 38 4/14/98 5:06p Dave
* Don't load or send invalid pilot pics. Fixed chatbox graphic errors.
* Made chatbox display team icons in a team vs. team game. Fixed up pause
* and endgame sequencing issues.
*
* 37 4/13/98 4:30p Hoffoss
* Fixed a bunch of stupid little bugs in options screen. Also changed
* forced_draw() to work like it used to.
*
* 36 4/11/98 7:59p Lawrance
* Add support for help overlays
*
* 35 4/10/98 4:51p Hoffoss
* Made several changes related to tooltips.
*
* 34 3/12/98 4:03p Lawrance
* Only allow one pressed button at a time
*
* 33 2/11/98 6:24p Hoffoss
* Fixed bug where disabled and hidden buttons give failed sound when
* pressed. Shouldn't happen when they are hidden.
*
* 32 2/06/98 3:36p Hoffoss
* Made disabled buttons play failed sound if clicked on. This is now
* standard behavior for all UI buttons everywhere.
*
* 31 2/03/98 4:21p Hoffoss
* Made UI controls draw white text when disabled.
*
* 30 1/26/98 6:28p Lawrance
* Add ability to for a button press event externally.
*
* 29 1/16/98 4:36p Hoffoss
* Fixed hotkey so it doesn't register twice if mouse is also over button.
*
* 28 1/15/98 3:07p Hoffoss
* Fixed bug where button couldn't be pressed by the mouse now. Argh.
*
* 27 1/15/98 2:59p Hoffoss
* Fixed bug with hotkeys not working unless mouse was actually over
* button as well.
*
* 26 1/15/98 1:58p Hoffoss
* Made buttons that don't repeat only trigger when the mouse button goes
* up while over the button.
*
* 25 1/15/98 11:09a Hoffoss
* Embelished this file with nifty comments.
*
* 24 1/15/98 10:28a Hoffoss
* Fixed ui buttons to handle modified hotkeys (like Shift-arrow) and
* fixed bug in debriefing.
*
* 23 1/14/98 6:43p Hoffoss
* Massive changes to UI code. A lot cleaner and better now. Did all
* this to get the new UI_DOT_SLIDER to work properly, which the old code
* wasn't flexible enough to handle.
*
* 22 1/02/98 9:11p Lawrance
* Add button_hot() function
*
* 21 11/19/97 8:32p Hoffoss
* Changed UI buttons so they go back to unpressed when they are disabled.
*
* 20 11/16/97 3:19p Hoffoss
* Fixed the code style so I could read the stuff.
*
* 19 10/29/97 7:25p Hoffoss
* Added crude support for UI button double click checking.
*
* 18 10/01/97 4:39p Lawrance
* null out text when free'ed
*
* 17 9/30/97 8:50p Lawrance
* don't eat keypress when a hotkey is used
*
* 16 9/18/97 10:32p Lawrance
* fix a bug that was wiping out some flags when reset was called
*
* 15 9/07/97 10:05p Lawrance
* remove sound refrences in code, use callbacks instead
*
* 14 8/30/97 12:23p Lawrance
* add button function to reset the status of a button
*
* 13 8/26/97 9:23a Lawrance
* fix bug with repeatable buttons
*
* 12 8/24/97 5:24p Lawrance
* improve drawing of buttons
*
* 11 8/18/97 5:28p Lawrance
* integrating sounds for when mouse goes over an active control
*
* 10 8/17/97 2:42p Lawrance
* add code to have selected bitmap for buttons linger for a certain time
*
* 9 6/13/97 5:51p Lawrance
* add in support for repeating buttons
*
* 8 6/12/97 11:09p Lawrance
* getting map and text integrated into briefing
*
* 7 6/12/97 12:39p John
* made ui use freespace colors
*
* 6 6/11/97 1:13p John
* Started fixing all the text colors in the game.
*
* 5 5/22/97 5:36p Lawrance
* allowing custom art for scrollbars
*
* 4 5/21/97 11:07a Lawrance
* integrate masks and custom bitmaps
*
* 3 1/28/97 4:58p Lawrance
* allowing hidden UI components
*
* 2 12/03/96 11:29a John
* Made scroll buttons on listbox scroll once, then delay, then repeat
* when the buttons are held down.
*
* 1 11/14/96 6:55p John
*
* $NoKeywords: $
*/
#include "ui/uidefs.h"
#include "ui/ui.h"
#include "io/timer.h"
#include "gamesnd/gamesnd.h"
#include "globalincs/alphacolors.h"
// ---------------------------------------------------------------------------------------
// input:
// do_repeat => property of button, set to 1 to allow pressed events if mouse
// pointer is held over button with left mouse button down,
// otherwise 0 (useful for buttons that scroll items)
// ignore_focus => whether to allow Enter/Spacebar to affect pressed state when
// control has focus
//
void UI_BUTTON::create(UI_WINDOW *wnd, char *_text, int _x, int _y, int _w, int _h, int do_repeat, int ignore_focus)
{
text = NULL;
if (_text) {
if ( strlen(_text) > 0 ) {
text = vm_strdup(_text);
}
}
// register gadget with UI window
base_create( wnd, UI_KIND_BUTTON, _x, _y, _w, _h );
// initialize variables
m_flags = 0;
next_repeat = 0;
m_just_highlighted_function = NULL; // assume there is no callback
m_disabled_function = NULL; // ditto
if (do_repeat) {
m_flags |= BF_REPEATS;
next_repeat = 1;
}
m_press_linger = 1;
first_callback = 1;
hotkey_if_focus = KEY_SPACEBAR;
if (ignore_focus){
m_flags |= BF_IGNORE_FOCUS;
}
custom_cursor_bmap = -1;
previous_cursor_bmap = -1;
}
void UI_BUTTON::destroy()
{
if (text) {
vm_free(text);
text = NULL;
}
UI_GADGET::destroy(); // call base as well
}
// sets a hotkey for button that works only when it had focus (or derived focus)
void UI_BUTTON::set_hotkey_if_focus(int key)
{
hotkey_if_focus = key;
}
void UI_BUTTON::reset_status()
{
m_flags &= ~BF_HIGHLIGHTED;
m_flags &= ~BF_HOTKEY_JUST_PRESSED;
m_flags &= ~BF_DOWN;
m_flags &= ~BF_DOUBLE_CLICKED;
m_flags &= ~BF_JUST_HIGHLIGHTED;
m_flags &= ~BF_CLICKED;
}
// reset anything that needs to be at the start of a new frame before processing
void UI_BUTTON::frame_reset()
{
m_flags &= ~BF_HIGHLIGHTED;
m_flags &= ~BF_HOTKEY_JUST_PRESSED;
m_flags &= ~BF_DOWN;
m_flags &= ~BF_JUST_PRESSED;
m_flags &= ~BF_JUST_RELEASED;
m_flags &= ~BF_CLICKED;
m_flags &= ~BF_DOUBLE_CLICKED;
m_flags &= ~BF_JUST_HIGHLIGHTED;
restore_previous_cursor();
}
// Force button to draw a specified frame
void UI_BUTTON::draw_forced(int frame_num)
{
if (uses_bmaps) {
if (bmap_ids[frame_num] >= 0) {
gr_set_bitmap(bmap_ids[frame_num]);
gr_bitmap(x, y);
// my_wnd->draw_tooltip();
// redraw any associated xstr
my_wnd->draw_XSTR_forced(this, frame_num);
}
}
}
// Render button. How it draws exactly depends on it's current state.
void UI_BUTTON::draw()
{
int offset, frame_num = -1;
if (uses_bmaps) {
gr_reset_clip();
// if button is down, draw it that way
if (button_down()) {
if (bmap_ids[B_PRESSED] >= 0){
frame_num = B_PRESSED;
}
// otherwise if button is disabled, draw it that way
} else if (disabled_flag) {
if (bmap_ids[B_DISABLED] >= 0){
frame_num = B_DISABLED;
}
// otherwise, if button is highlighted (mouse is over it, but mouse buttons not down) draw it that way
} else if (m_flags & BF_HIGHLIGHTED) {
if (bmap_ids[B_HIGHLIGHT] >= 0){
frame_num = B_HIGHLIGHT;
}
// otherwise, just draw it normally
} else {
if (bmap_ids[B_NORMAL] >= 0){
frame_num = B_NORMAL;
}
}
if (frame_num >= 0) {
gr_set_bitmap(bmap_ids[frame_num]);
gr_bitmap(x, y);
}
} else {
gr_set_font(my_wnd->f_id);
gr_set_clip( x, y, w, h );
// draw the button's box
if (button_down()) {
ui_draw_box_in( 0, 0, w-1, h-1 );
offset = 1;
} else {
ui_draw_box_out( 0, 0, w-1, h-1 );
offset = 0;
}
// now draw the button's text
if (disabled_flag){
gr_set_color_fast(&CDARK_GRAY);
} else if (my_wnd->selected_gadget == this){
gr_set_color_fast(&CBRIGHT_GREEN);
} else {
gr_set_color_fast(&CBLACK);
}
if (text){
ui_string_centered( Middle(w) + offset, Middle(h) + offset, text );
}
gr_reset_clip();
}
}
// process() is called to process the button, which amounts to:
// If mouse is over button, hilight it
// If highlighted and mouse button down, flag button as down
// If hotkey pressed, flag button as down
// If hotkey_if_focus pressed, and button has focus, flag button as down
// Set various BF_JUST_* flags if events changed from last frame
//
void UI_BUTTON::process(int focus)
{
int mouse_on_me, old_flags;
old_flags = m_flags;
frame_reset();
// check mouse over control and handle hilighting state
mouse_on_me = is_mouse_on();
// if gadget is disabled, force button up and return
if (disabled_flag) {
if (old_flags & BF_DOWN){
m_flags |= BF_JUST_RELEASED;
}
if (!hidden && !my_wnd->use_hack_to_get_around_stupid_problem_flag) {
if (mouse_on_me && B1_JUST_PRESSED){
gamesnd_play_iface(SND_GENERAL_FAIL);
}
if ( (hotkey >= 0) && (my_wnd->keypress == hotkey) ){
gamesnd_play_iface(SND_GENERAL_FAIL);
}
}
// do callback if the button is disabled
if (mouse_on_me && B1_JUST_PRESSED){
if (m_disabled_function != NULL) {
m_disabled_function();
}
}
return;
}
// check focus and derived focus with one variable
if (my_wnd->selected_gadget == this) {
focus = 1;
}
// show alternate cursor, perhaps?
maybe_show_custom_cursor();
if ( !mouse_on_me ) {
next_repeat = 0;
} else {
m_flags |= BF_HIGHLIGHTED;
if ( !(old_flags & BF_HIGHLIGHTED) ) {
int do_callback = 1;
m_flags |= BF_JUST_HIGHLIGHTED;
// if a callback exists, call it
if (m_just_highlighted_function) {
if ( m_flags & BF_SKIP_FIRST_HIGHLIGHT_CALLBACK ) {
if ( first_callback ) {
do_callback = 0;
}
}
first_callback = 0;
if ( do_callback ) {
m_just_highlighted_function();
}
}
}
}
// check if mouse is pressed
if ( B1_PRESSED && mouse_on_me ) {
m_flags |= BF_DOWN;
capture_mouse();
}
// check if hotkey is down or not
if ( (hotkey >= 0) && (my_wnd->keypress == hotkey) ) {
m_flags |= BF_DOWN | BF_CLICKED;
}
// only check for space/enter keystrokes if we are not ignoring the focus (this is the
// default behavior)
if ( !(m_flags & BF_IGNORE_FOCUS) ) {
if ( focus && (hotkey_if_focus >= 0) ) {
if (my_wnd->keypress == hotkey_if_focus)
m_flags |= BF_DOWN | BF_CLICKED;
if ( (hotkey_if_focus == KEY_SPACEBAR) && (my_wnd->keypress == KEY_ENTER) )
m_flags |= BF_DOWN | BF_CLICKED;
}
}
// handler for button not down
if ( !(m_flags & BF_DOWN) ) {
next_repeat = 0;
if ( (old_flags & BF_DOWN) && !(old_flags & BF_CLICKED) ) // check for release of mouse, not hotkey
m_flags |= BF_JUST_RELEASED;
// non-repeating buttons behave sort of uniquely.. They activate when released over button
if (!(m_flags & BF_REPEATS)) {
if ( (m_flags & BF_JUST_RELEASED) && (m_flags & BF_HIGHLIGHTED) )
m_flags |= BF_CLICKED;
}
return;
}
// check if button just went down this frame
if ( !(old_flags & BF_DOWN) ) {
m_flags |= BF_JUST_PRESSED;
m_press_linger = timestamp(100);
if (user_function)
user_function();
if (m_flags & BF_REPEATS) {
next_repeat = timestamp(B_REPEAT_TIME * 3);
m_flags |= BF_CLICKED;
}
}
// check if a repeat event should occur
if ( timestamp_elapsed(next_repeat) && (m_flags & BF_REPEATS) ) {
next_repeat = timestamp(B_REPEAT_TIME);
m_flags |= BF_CLICKED;
m_press_linger = timestamp(100);
}
// check for double click occurance
if (B1_DOUBLE_CLICKED && mouse_on_me) {
m_flags |= BF_DOUBLE_CLICKED;
m_press_linger = timestamp(100);
}
}
// Check if button should do it's function in life (trigger the event)
//
int UI_BUTTON::pressed()
{
if (m_flags & BF_CLICKED)
return TRUE;
return FALSE;
}
int UI_BUTTON::double_clicked()
{
if ( m_flags & BF_DOUBLE_CLICKED )
return TRUE;
else
return FALSE;
}
int UI_BUTTON::just_pressed()
{
if ( m_flags & BF_JUST_PRESSED )
return TRUE;
else
return FALSE;
}
int UI_BUTTON::just_highlighted()
{
if ( m_flags & BF_JUST_HIGHLIGHTED )
return TRUE;
else
return FALSE;
}
// ----------------------------------------------------------------------------------
// Checks if button is down (or up). This checks the button instead, rather than any
// events that may have caused it to be down. Buttons also stay down for a certain amount
// of time minimum, to make sure it's long enough for the user to see it has went down (since
// one frame is probably far to quick for users to notice it). Basically, this indicates
// how the button is being drawn, if you want to think of it that way.
int UI_BUTTON::button_down()
{
if ( (m_flags & BF_DOWN) || !timestamp_elapsed(m_press_linger) )
return TRUE;
else
return FALSE;
}
// ------------------------------------------------------------
// set the callback function for when the mouse first goes over
// a button
//
void UI_BUTTON::set_highlight_action( void (*_user_function)(void) )
{
m_just_highlighted_function = _user_function;
}
void UI_BUTTON::set_disabled_action( void (*_user_function)(void) )
{
m_disabled_function = _user_function;
}
// Is the mouse over this button?
int UI_BUTTON::button_hilighted()
{
return m_flags & BF_HIGHLIGHTED;
}
// Is the mouse over this button?
void UI_BUTTON::set_button_hilighted()
{
m_flags |= BF_HIGHLIGHTED;
}
// Force button to get pressed
void UI_BUTTON::press_button()
{
if ( !disabled_flag ) {
m_flags |= BF_DOWN | BF_CLICKED;
//m_flags |= BF_JUST_PRESSED;
}
}
// reset the "pressed" timestamps
void UI_BUTTON::reset_timestamps()
{
m_press_linger = 1;
next_repeat = 0;
}
void UI_BUTTON::skip_first_highlight_callback()
{
m_flags |= BF_SKIP_FIRST_HIGHLIGHT_CALLBACK;
first_callback = 1;
}
void UI_BUTTON::repeatable(int yes)
{
if(yes){
m_flags |= BF_REPEATS;
next_repeat = 1;
} else {
m_flags &= ~(BF_REPEATS);
next_repeat = 0;
}
}
void UI_BUTTON::maybe_show_custom_cursor()
{
if (disabled_flag)
return;
// set the mouseover cursor
if (is_mouse_on()) {
if ((custom_cursor_bmap >= 0) && (previous_cursor_bmap < 0)) {
previous_cursor_bmap = gr_get_cursor_bitmap();
gr_set_cursor_bitmap(custom_cursor_bmap, GR_CURSOR_LOCK); // set and lock
}
}
}
void UI_BUTTON::restore_previous_cursor()
{
if (previous_cursor_bmap >= 0) {
gr_set_cursor_bitmap(previous_cursor_bmap, GR_CURSOR_UNLOCK); // restore and unlock
previous_cursor_bmap = -1;
}
}
Reference in new issue View Git Blame Copy Permalink