____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

interface.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1998-2007 by Lutz Sammer and Jimmy Salmon
//
//      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; only version 2 of the License.
//
//      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.

#ifndef __INTERFACE_H__
#define __INTERFACE_H__


/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

#include "icons.h"

/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

class CUnit;
struct _event_callback_;

/*----------------------------------------------------------------------------
--  Definitons
----------------------------------------------------------------------------*/

enum ButtonCmd {
    ButtonMove,           
    ButtonAttack,         
    ButtonRepair,         
    ButtonHarvest,        
    ButtonBuild,          
    ButtonPatrol,         
    ButtonAttackGround,   
    ButtonSpellCast,      
    ButtonUnload,         
    ButtonStop,           
    ButtonButton,         
    ButtonTrain,          
    ButtonStandGround,    
    ButtonCancel,         
    ButtonCancelTrain,    
    ButtonCancelBuild,    
};

class ButtonAction;
typedef bool (*ButtonCheckFunc)(const CUnit *, const ButtonAction *);

class ButtonAction {
public:
    ButtonAction() : Pos(0), Level(0), Action(ButtonMove), Value(0),
        Allowed(NULL), Key(0) {}

    int Pos;          
    int Level;        
    ButtonCmd Action; 
    int Value;        
    std::string ValueStr;    

    ButtonCheckFunc Allowed; 
    std::string AllowStr;    
    std::string UnitMask;    
    IconConfig  Icon;        
    int Key;                 
    std::string Hint;        
};

enum _button_area_ {
    ButtonAreaSelected,      
    ButtonAreaTraining,      
    ButtonAreaTransporting,  
    ButtonAreaButton,        
    ButtonAreaMenu,          
};

enum _menu_button_under_ {
    ButtonUnderMenu,              
    ButtonUnderNetworkMenu,       
    ButtonUnderNetworkDiplomacy,  
};

enum _iface_state_ {
    IfaceStateNormal,  
    IfaceStateMenu,    
};

enum _key_state_ {
    KeyStateCommand = 0,  
    KeyStateInput         
};                        

#define ModifierShift 1        
#define ModifierControl 2      
#define ModifierAlt 4          
#define ModifierSuper 8        
#define ModifierDoublePress 16 

#define MouseDoubleShift 8   
#define MouseDragShift   16  
#define MouseHoldShift   24  

#define NoButton 0      
#define LeftButton 2    
#define MiddleButton 4  
#define RightButton 8   

#define UpButton 16    
#define DownButton 32  

#define LeftAndMiddleButton  (LeftButton | MiddleButton)  
#define LeftAndRightButton   (LeftButton | RightButton)   
#define MiddleAndRightButton (MiddleButton | RightButton) 

enum _cursor_on_ {
    CursorOnUnknown = -1,     
    CursorOnMinimap,          
    CursorOnButton,           
    CursorOnMap,              
    CursorOnScrollUp,         
    CursorOnScrollDown,       
    CursorOnScrollLeft,       
    CursorOnScrollRight,      
    CursorOnScrollLeftUp,     
    CursorOnScrollLeftDown,   
    CursorOnScrollRightUp,    
    CursorOnScrollRightDown,  
};

#define ScrollNone 0        
#define ScrollUp 1          
#define ScrollDown 2        
#define ScrollLeft 4        
#define ScrollRight 8       
#define ScrollLeftUp 5      
#define ScrollLeftDown 6    
#define ScrollRightUp 9     
#define ScrollRightDown 10  

/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/

extern bool GameRunning;
extern bool GamePaused;
extern bool GameObserve;
extern char SkipGameCycle;
extern bool GodMode;
extern char BigMapMode;

extern int MouseButtons;
extern int KeyModifiers;
extern enum _iface_state_ InterfaceState;
extern int KeyScrollState;
extern int MouseScrollState;
extern enum _key_state_ KeyState;
extern CUnit *UnitUnderCursor;
extern int ButtonAreaUnderCursor;
extern int ButtonUnderCursor;
extern bool GameMenuButtonClicked;
extern bool GameDiplomacyButtonClicked;
extern bool LeaveStops;
extern enum _cursor_on_ CursorOn;

extern int CurrentButtonLevel;

extern int DoubleClickDelay;
extern int HoldClickDelay;

/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

//
// in botpanel.cpp
//
extern void InitButtons(void);
extern void CleanButtons(void);
extern int AddButton(int pos, int level, const std::string &IconIdent,
    ButtonCmd action, const std::string &value, const ButtonCheckFunc func,
    const std::string &arg, const std::string &hint, const std::string &umask);

//
// in mouse.cpp
//
extern void HandleButtonDown(unsigned button);
extern void HandleButtonUp(unsigned button);
extern void HandleCursorMove(int *x, int *y);
extern void HandleMouseMove(int x, int y);
extern void HandleMouseExit(void);

extern int HandleKeyModifiersDown(unsigned keycode, unsigned keychar);
extern int HandleKeyModifiersUp(unsigned keycode, unsigned keychar);

extern void HandleKeyDown(unsigned keycode, unsigned keychar);
extern void HandleKeyUp(unsigned keycode, unsigned keychar);
extern void HandleKeyRepeat(unsigned keycode, unsigned keychar);

//
// in interface.c (for link between video and mouse.c)
//
extern void InputMouseButtonPress(const struct _event_callback_ *callbacks,
    unsigned ticks, unsigned button);
extern void InputMouseButtonRelease(const struct _event_callback_ *callbacks,
    unsigned ticks, unsigned button);
extern void InputMouseMove(const struct _event_callback_ *callbacks,
    unsigned ticks, int x, int y);
extern void InputMouseExit(const struct _event_callback_ *callbacks,
    unsigned ticks);
extern void InputMouseTimeout(const struct _event_callback_ *callbacks,
    unsigned ticks);

extern void InputKeyButtonPress(const struct _event_callback_ *callbacks,
    unsigned ticks, unsigned ikey, unsigned ikeychar);
extern void InputKeyButtonRelease(const struct _event_callback_ *callbacks,
    unsigned ticks, unsigned ikey, unsigned ikeychar);
extern void InputKeyTimeout(const struct _event_callback_ *callbacks,
    unsigned ticks);

extern int GetDoubleClickDelay(void);
extern void SetDoubleClickDelay(int delay);
extern int GetHoldClickDelay(void);
extern void SetHoldClickDelay(int delay);

extern void UiTogglePause(void);
extern int HandleCheats(const std::string &input);

bool HandleCommandKey(int key);

//
// Chaos pur.
//
extern void DoRightButton(int tx, int ty);
extern void CancelBuildingMode(void);

extern void DrawMenuButtonArea(void);
extern void UpdateMessages(void);
extern void DrawMessages(void);
extern void DrawResources(void);
extern void SetMessage(const char *fmt, ...);
extern void SetMessageEvent(int x, int y, const char *fmt, ...);
extern void CenterOnMessage(void);
extern void CleanMessages(void);

extern void DrawCosts(void);
extern void SetCosts(int mana, const int *costs);
extern void ClearCosts(void);

extern void DrawTimer(void);
extern void UpdateTimer(void);
extern void UpdateStatusLineForButton(const ButtonAction *button);
extern void DrawPieMenu(void);

extern int HandleMouseScrollArea(int x, int y);

//
// in button_checks.cpp
//
extern bool ButtonCheckTrue(const CUnit *unit,
    const ButtonAction *button);
extern bool ButtonCheckFalse(const CUnit *unit,
    const ButtonAction *button);
extern bool ButtonCheckUnitsOr(const CUnit *unit,
    const ButtonAction *button);
extern bool ButtonCheckUnitsAnd(const CUnit *unit,
    const ButtonAction *button);
extern bool ButtonCheckNetwork(const CUnit *unit,
    const ButtonAction *button);
extern bool ButtonCheckNoNetwork(const CUnit *unit,
    const ButtonAction *button);
extern bool ButtonCheckNoWork(const CUnit *unit,
    const ButtonAction *button);
extern bool ButtonCheckAttack(const CUnit *unit,
    const ButtonAction *button);

//
// in script_ui.cpp
//
extern void SelectionChanged(void);
extern void SelectedUnitChanged(void);

//
// in game.cpp
//
extern void SetGamePaused(bool paused);
extern bool GetGamePaused();
extern void SetGameSpeed(int speed);
extern int GetGameSpeed();


#endif // !__INTERFACE_H__

---