ryzom/client/src/interface_v3/action_handler_help.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2012  Matt RAYKOWSKI (sfb) <matt.raykowski@gmail.com>
   6 // Copyright (C) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   7 //
   8 // This program is free software: you can redistribute it and/or modify
   9 // it under the terms of the GNU Affero General Public License as
  10 // published by the Free Software Foundation, either version 3 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU Affero General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Affero General Public License
  19 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22
  23 #ifndef CL_ACTION_HANDLER_HELP_H
  24 #define CL_ACTION_HANDLER_HELP_H
  25
  26
  27 #include "inventory_manager.h"
  28 #include "bot_chat_manager.h"
  29
  30
  31 // Struct that tells how to setup a help window
  32 class CSheetHelpSetup
  33 {
  34 public:
  35         CInterfaceGroup *HelpWindow;
  36         CDBCtrlSheet     *SrcSheet;                     // the sheet for which info should be displayed (outside of the help window)
  37         CDBCtrlSheet     *DestSheet;            // copy of the sheet for which info are asked (this sheet is in the help window, the source sheet is copied in it)
  38         std::string      ViewText;                      // id of the text inside the help window that receive infos about the sheet
  39         std::string      ViewTextID;            // id of the text_id inside the help window that receive infos about the sheet (for dynamic infos -> missions)
  40         std::string              ScrollTextGroup;   // name of the group that contains the description text
  41         std::string              ScrollTextIdGroup; // name of the group that contains the description text_id
  42         std::string              CreatorViewTextID; // name of the text_id in the help window that contain the name of the item's creator
  43         std::string              PrefixForExtra;        // Id Prefix for list brick and mp stats (from the help window root)
  44         bool                     FromBotChat;
  45
  46 public:
  47         // ctor
  48         CSheetHelpSetup()
  49         {
  50                 HelpWindow = NULL;
  51                 SrcSheet = NULL;
  52                 DestSheet = NULL;
  53                 FromBotChat= false;
  54         }
  55         // set the default ids for help window
  56         void setupDefaultIDs();
  57 };
  58
  59
  60 // reset some elements in the windows (brick lists etc...)
  61 void resetSheetHelp(CSheetHelpSetup &setup);
  62
  63 // Setup help for a sheet in a window. Type is deduced from the sheet
  64 void setupSheetHelp(CSheetHelpSetup &setup);
  65
  66 // Refresh help for an item
  67 void refreshItemHelp(CSheetHelpSetup &setup);
  68 // refresh help for a mission
  69 void refreshMissionHelp(CSheetHelpSetup &setup, const CPrerequisitInfos &infos);
  70
  71 class CPetAnimalItemInfoWaiter : public IItemInfoWaiter
  72 {
  73         void infoReceived()
  74         {
  75                 //ItemSheet
  76                 //ItemSlotId
  77                 CClientItemInfo info = getInventory().getItemInfo(ItemSlotId);
  78         }
  79 };
  80
  81
  82 // ***************************************************************************
  83 /** static methods to manipulate Helps
  84  */
  85 class   CInterfaceHelp
  86 {
  87 public:
  88         // Open and set the group next to the element
  89         static CInterfaceGroup  *activateNextWindow(CDBCtrlSheet *elt, sint forceKeepWindow=-1);
  90
  91         // Close all the Help Windows
  92         static  void                    closeAll();
  93
  94         // remove waiter for ItemInfo
  95         static  void                    removeWaiterItemInfo(uint i);
  96         static  void                    removeWaiterMissionInfo(uint i);
  97
  98         static  void                    changeKeepMode(uint i);
  99         static  void                    setKeepMode(uint i, bool state);
 100
 101         // init windows default pos.
 102         static  void                    resetWindowPos(sint y);
 103
 104         // serial info windows
 105         static void                             serialInfoWindows(NLMISC::IStream &f);
 106
 107         // debug info windows
 108         static void                             debugOpenedInfoWindows();
 109
 110         // update SPhrase Text of all opened windows
 111         static void                             updateWindowSPhraseTexts();
 112
 113         // release the manager
 114         static void                             release();
 115
 116 private:
 117         friend class    CHandlerHelpKeep;
 118         friend class    CAHItemHelpMpChangeItemPart;
 119
 120         class   CInfoWindowSave
 121         {
 122         public:
 123                 sint32  X, Y;
 124                 void    serial(NLMISC::IStream &f)
 125                 {
 126                         f.serialVersion(0);
 127                         f.serial(X, Y);
 128                 }
 129         };
 130         class   CInfoWindow : public IItemInfoWaiter, public IMissionPrereqInfosWaiter
 131         {
 132         public:
 133                 // The Info Window
 134                 CInterfaceGroupPtr      Window;
 135                 // The item used to open this window
 136                 CDBCtrlSheet    *CtrlSheet;
 137                 // KeepMode
 138                 bool                    KeepMode;
 139                 // The button for KeepMode. Button state == KeepMode
 140                 CCtrlBaseButtonPtr      KeepButton;
 141         public:
 142                 CInfoWindow() : CtrlSheet(NULL) {KeepMode= false;}
 143                 virtual void    infoReceived();
 144                 virtual void    missionInfoReceived(const CPrerequisitInfos &infos);
 145         };
 146
 147         // update the brick help window when weight of hands has changed
 148         class CFittedWeaponWeightObserver : public NLMISC::ICDBNode::IPropertyObserver
 149         {
 150         public:
 151                 virtual void update(NLMISC::ICDBNode* node);
 152         };
 153
 154
 155         static std::deque<uint>                         _ActiveWindows;
 156         static std::vector<CInfoWindow>         _InfoWindows;
 157         static bool                                                     _InfoWindowInit;
 158         static CFittedWeaponWeightObserver  _FittedWeaponWeightObserver;
 159
 160         static void             initWindows();
 161 };
 162
 163
 164
 165 #endif