client/src/st_lib.h

Go to the documentation of this file.

// Emacs style mode select   -*- C++ -*-
//-----------------------------------------------------------------------------
//
// $Id: st_lib.h 1788 2010-08-24 04:42:57Z russellrice $
//
// Copyright (C) 1993-1996 by id Software, Inc.
// Copyright (C) 2006-2010 by The Odamex Team.
//
// 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.
//
// DESCRIPTION:
//      The status bar widget code.
//
//-----------------------------------------------------------------------------


#ifndef __STLIB__
#define __STLIB__


// We are referring to patches.
#include "r_defs.h"


//
// Background and foreground screen numbers
//
// [RH] Status bar is another screen allocated
// by status bar code instead of video code.
extern DCanvas *stbarscreen;
extern DCanvas *stnumscreen;
#define BG (stbarscreen)
#define FG (screen)



//
// Typedefs of widgets
//

// Number widget

struct st_number_s
{
        // upper right-hand corner
        //      of the number (right-justified)
        int             x;
        int             y;

        // max # of digits in number
        int width;

        // last number value
        int             oldnum;

        // pointer to current value
        int*            num;

        // pointer to bool stating
        //      whether to update number
        bool*   on;

        // list of patches for 0-9
        patch_t**       p;

        // user data
        int data;

};
typedef struct st_number_s st_number_t;



// Percent widget ("child" of number widget,
//      or, more precisely, contains a number widget.)
struct st_percent_s
{
        // number information
        st_number_t             n;

        // percent sign graphic
        patch_t*                        p;

};
typedef struct st_percent_s st_percent_t;


// Multiple Icon widget
struct st_multicon_s
{
         // center-justified location of icons
        int                             x;
        int                             y;

        // last icon number
        int                             oldinum;

        // pointer to current icon
        int*                            inum;

        // pointer to bool stating
        //      whether to update icon
        bool*                           on;

        // list of icons
        patch_t**                       p;

        // user data
        int                             data;

};
typedef struct st_multicon_s st_multicon_t;



// Binary Icon widget

struct st_binicon_s
{
        // center-justified location of icon
        int                             x;
        int                             y;

        // last icon value
        bool                    oldval;

        // pointer to current icon status
        bool*                   val;

        // pointer to bool
        //      stating whether to update icon
        bool*                   on;


        patch_t*                        p;              // icon
        int                             data;   // user data

};
typedef struct st_binicon_s st_binicon_t;


//
// Widget creation, access, and update routines
//

// Initializes widget library.
// More precisely, initialize STMINUS,
//      everything else is done somewhere else.
//
void STlib_init(void);



// Number widget routines
void
STlib_initNum
( st_number_t*                  n,
  int                                   x,
  int                                   y,
  patch_t**                     pl,
  int*                                  num,
  bool*                         on,
  int                                   width );

void
STlib_updateNum
( st_number_t*                  n,
  bool                          refresh );


// Percent widget routines
void
STlib_initPercent
( st_percent_t*                 p,
  int                                   x,
  int                                   y,
  patch_t**                     pl,
  int*                                  num,
  bool*                         on,
  patch_t*                              percent );


void
STlib_updatePercent
( st_percent_t*                 per,
  bool                                  refresh );


// Multiple Icon widget routines
void
STlib_initMultIcon
( st_multicon_t*                mi,
  int                                   x,
  int                                   y,
  patch_t**                     il,
  int*                                  inum,
  bool*                         on );


void
STlib_updateMultIcon
( st_multicon_t*                mi,
  bool                          refresh );

// Binary Icon widget routines
void
STlib_initBinIcon
( st_binicon_t*                 b,
  int                                   x,
  int                                   y,
  patch_t*                              i,
  bool*                         val,
  bool*                         on );

void
STlib_updateBinIcon
( st_binicon_t*                 bi,
  bool                          refresh );

#endif