nel/src/gui/group_modal.cpp

   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) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21 #include "stdpch.h"
  22 #include "nel/gui/group_modal.h"
  23 #include "nel/gui/interface_element.h"
  24 #include "nel/misc/xml_auto_ptr.h"
  25 #include "nel/gui/view_renderer.h"
  26 #include "nel/misc/i_xml.h"
  27
  28 using namespace std;
  29
  30 #ifdef DEBUG_NEW
  31 #define new DEBUG_NEW
  32 #endif
  33
  34 namespace NLGUI
  35 {
  36
  37         NLMISC_REGISTER_OBJECT(CViewBase, CGroupModal, std::string, "modal");
  38
  39         // ***************************************************************************
  40         CGroupModal::CGroupModal(const TCtorParam &param)
  41         : CGroupFrame(param)
  42         {
  43                 SpawnOnMousePos= true;
  44                 ExitClickOut= true;
  45                 ExitClickL= false;
  46                 ExitClickR= false;
  47                 ExitKeyPushed = false;
  48                 ForceInsideScreen= false;
  49                 SpawnMouseX= SpawnMouseY= 0;
  50                 _MouseDeltaX= _MouseDeltaY= 0;
  51                 //By default, modal are escapable
  52                 _Escapable= true;
  53         }
  54
  55
  56         std::string CGroupModal::getProperty( const std::string &name ) const
  57         {
  58                 if( name == "mouse_pos" )
  59                 {
  60                         return NLMISC::toString( SpawnOnMousePos );
  61                 }
  62                 else
  63                 if( name == "exit_click_out" )
  64                 {
  65                         return NLMISC::toString( ExitClickOut );
  66                 }
  67                 else
  68                 if( name == "exit_click_l" )
  69                 {
  70                         return NLMISC::toString( ExitClickL );
  71                 }
  72                 else
  73                 if( name == "exit_click_r" )
  74                 {
  75                         return NLMISC::toString( ExitClickR );
  76                 }
  77                 else
  78                 if( name == "exit_click_b" )
  79                 {
  80                         if( ExitClickL == ExitClickR )
  81                                 return NLMISC::toString( ExitClickL );
  82                         else
  83                                 return "false";
  84                 }
  85                 else
  86                 if( name == "force_inside_screen" )
  87                 {
  88                         return NLMISC::toString( ForceInsideScreen );
  89                 }
  90                 else
  91                 if( name == "category" )
  92                 {
  93                         return Category;
  94                 }
  95                 else
  96                 if( name == "onclick_out" )
  97                 {
  98                         return OnClickOut;
  99                 }
 100                 else
 101                 if( name == "onclick_out_params" )
 102                 {
 103                         return OnClickOutParams;
 104                 }
 105                 else
 106                 if( name == "onpostclick_out" )
 107                 {
 108                         return OnPostClickOut;
 109                 }
 110                 else
 111                 if( name == "onpostclick_out_params" )
 112                 {
 113                         return OnPostClickOutParams;
 114                 }
 115                 else
 116                 if( name == "exit_key_pushed" )
 117                 {
 118                         return NLMISC::toString( ExitKeyPushed );
 119                 }
 120                 else
 121                         return CGroupFrame::getProperty( name );
 122         }
 123
 124         void CGroupModal::setProperty( const std::string &name, const std::string &value )
 125         {
 126                 if( name == "mouse_pos" )
 127                 {
 128                         bool b;
 129                         if( NLMISC::fromString( value, b ) )
 130                                 SpawnOnMousePos = b;
 131                         return;
 132                 }
 133                 else
 134                 if( name == "exit_click_out" )
 135                 {
 136                         bool b;
 137                         if( NLMISC::fromString( value, b ) )
 138                                 ExitClickOut = b;
 139                         return;
 140                 }
 141                 else
 142                 if( name == "exit_click_l" )
 143                 {
 144                         bool b;
 145                         if( NLMISC::fromString( value, b ) )
 146                                 ExitClickL = b;
 147                         return;
 148                 }
 149                 else
 150                 if( name == "exit_click_r" )
 151                 {
 152                         bool b;
 153                         if( NLMISC::fromString( value, b ) )
 154                                 ExitClickR = b;
 155                         return;
 156                 }
 157                 else
 158                 if( name == "exit_click_b" )
 159                 {
 160                         bool b;
 161                         if( NLMISC::fromString( value, b ) )
 162                         {
 163                                 ExitClickL = ExitClickR = b;
 164                         }
 165                         return;
 166                 }
 167                 else
 168                 if( name == "force_inside_screen" )
 169                 {
 170                         bool b;
 171                         if( NLMISC::fromString( value, b ) )
 172                                 ForceInsideScreen = b;
 173                         return;
 174                 }
 175                 else
 176                 if( name == "category" )
 177                 {
 178                         Category = value;
 179                         return;
 180                 }
 181                 else
 182                 if( name == "onclick_out" )
 183                 {
 184                         OnClickOut = value;
 185                         return;
 186                 }
 187                 else
 188                 if( name == "onclick_out_params" )
 189                 {
 190                         OnClickOutParams = value;
 191                         return;
 192                 }
 193                 else
 194                 if( name == "onpostclick_out" )
 195                 {
 196                         OnPostClickOut = value;
 197                         return;
 198                 }
 199                 else
 200                 if( name == "onpostclick_out_params" )
 201                 {
 202                         OnPostClickOutParams = value;
 203                         return;
 204                 }
 205                 else
 206                 if( name == "exit_key_pushed" )
 207                 {
 208                         bool b;
 209                         if( NLMISC::fromString( value, b ) )
 210                                 ExitKeyPushed = b;
 211                         return;
 212                 }
 213                 else
 214                         CGroupFrame::setProperty( name, value );
 215         }
 216
 217
 218
 219         xmlNodePtr CGroupModal::serialize( xmlNodePtr parentNode, const char *type ) const
 220         {
 221                 xmlNodePtr node = CGroupFrame::serialize( parentNode, type );
 222                 if( node == NULL )
 223                         return NULL;
 224
 225                 xmlSetProp( node, BAD_CAST "type", BAD_CAST "modal" );
 226                 xmlSetProp( node, BAD_CAST "mouse_pos", BAD_CAST NLMISC::toString( SpawnOnMousePos ).c_str() );
 227                 xmlSetProp( node, BAD_CAST "exit_click_out", BAD_CAST NLMISC::toString( ExitClickOut ).c_str() );
 228                 xmlSetProp( node, BAD_CAST "exit_click_l", BAD_CAST NLMISC::toString( ExitClickL ).c_str() );
 229                 xmlSetProp( node, BAD_CAST "exit_click_r", BAD_CAST NLMISC::toString( ExitClickR ).c_str() );
 230
 231                 if( ExitClickL == ExitClickR )
 232                         xmlSetProp( node, BAD_CAST "exit_click_b", BAD_CAST NLMISC::toString( ExitClickL ).c_str() );
 233
 234                 xmlSetProp( node, BAD_CAST "force_inside_screen", BAD_CAST NLMISC::toString( ForceInsideScreen ).c_str() );
 235                 xmlSetProp( node, BAD_CAST "category", BAD_CAST Category.c_str() );
 236                 xmlSetProp( node, BAD_CAST "onclick_out", BAD_CAST OnClickOut.c_str() );
 237                 xmlSetProp( node, BAD_CAST "onclick_out_params", BAD_CAST OnClickOutParams.c_str() );
 238                 xmlSetProp( node, BAD_CAST "onpostclick_out", BAD_CAST OnPostClickOut.c_str() );
 239                 xmlSetProp( node, BAD_CAST "onpostclick_out_params", BAD_CAST OnPostClickOutParams.c_str() );
 240                 xmlSetProp( node, BAD_CAST "exit_key_pushed", BAD_CAST NLMISC::toString( ExitKeyPushed ).c_str() );
 241
 242                 return node;
 243         }
 244
 245         // ***************************************************************************
 246         bool CGroupModal::parse (xmlNodePtr cur, CInterfaceGroup *parentGroup)
 247         {
 248                 if(!CGroupFrame::parse(cur, parentGroup))
 249                         return false;
 250
 251                 // read modal option
 252                 CXMLAutoPtr     prop;
 253                 prop = xmlGetProp (cur, (xmlChar*)"mouse_pos");
 254                 if (prop)       SpawnOnMousePos= convertBool(prop);
 255                 prop = xmlGetProp (cur, (xmlChar*)"exit_click_out");
 256                 if (prop)       ExitClickOut= convertBool(prop);
 257                 prop = xmlGetProp (cur, (xmlChar*)"exit_click_l");
 258                 if (prop)       ExitClickL= convertBool(prop);
 259                 prop = xmlGetProp (cur, (xmlChar*)"exit_click_r");
 260                 if (prop)       ExitClickR= convertBool(prop);
 261                 prop = xmlGetProp (cur, (xmlChar*)"exit_click_b");
 262                 if (prop)       ExitClickR= ExitClickL= convertBool(prop);
 263                 prop = xmlGetProp (cur, (xmlChar*)"force_inside_screen");
 264                 if (prop)       ForceInsideScreen= convertBool(prop);
 265                 prop = xmlGetProp (cur, (xmlChar*)"category");
 266                 if (prop)       Category= (const char *) prop;
 267                 prop = xmlGetProp (cur, (xmlChar*)"onclick_out");
 268                 if (prop)       OnClickOut = (const char *) prop;
 269                 prop = xmlGetProp (cur, (xmlChar*)"onclick_out_params");
 270                 if (prop)       OnClickOutParams = (const char *) prop;
 271                 prop = xmlGetProp (cur, (xmlChar*)"onpostclick_out");
 272                 if (prop)       OnPostClickOut = (const char *) prop;
 273                 prop = xmlGetProp (cur, (xmlChar*)"onpostclick_out_params");
 274                 if (prop)       OnPostClickOutParams = (const char *) prop;
 275                 prop = xmlGetProp (cur, (xmlChar*)"exit_key_pushed");
 276                 if (prop)       ExitKeyPushed= convertBool(prop);
 277
 278                 // Force parent hotspot for spawn on mouse
 279                 if(SpawnOnMousePos)
 280                         setParentPosRef(Hotspot_BL);
 281
 282                 // bkup x/y as the deltas.
 283                 _MouseDeltaX= getX();
 284                 _MouseDeltaY= getY();
 285
 286                 // Modals are disabled by default
 287                 _Active = false;
 288
 289                 return true;
 290         }
 291
 292         // ***************************************************************************
 293         void CGroupModal::updateCoords ()
 294         {
 295                 // if snap to mouse pos.
 296                 if(SpawnOnMousePos)
 297                 {
 298                         // Special for menu for instance: If the size is bigger or equal to the screen, keep 0, because will be clipped just after
 299                         CViewRenderer &rVR = *CViewRenderer::getInstance();
 300                         uint32 w,h;
 301                         rVR.getScreenSize(w,h);
 302                         if(_W>=(sint32)w && _H>=(sint32)h)
 303                         {
 304                                 _X= _Y= 0;
 305                         }
 306                         else
 307                         {
 308                                 // change coords
 309                                 _X= SpawnMouseX+_MouseDeltaX;
 310                                 _Y= SpawnMouseY+_MouseDeltaY;
 311                         }
 312                 }
 313
 314                 // update group
 315                 CGroupFrame::updateCoords();
 316
 317                 // if snap to mouse pos or ForceInsideScreen
 318                 if(SpawnOnMousePos || ForceInsideScreen)
 319                 {
 320                         bool clipped = false;
 321                         // repos the group according to real size. clip against screen
 322                         if(_XReal<0)
 323                         {
 324                                 _X+= -_XReal;
 325                                 clipped = true;
 326                         }
 327                         else
 328                         {
 329                                 if (!SpawnOnMousePos)
 330                                         _X = _MouseDeltaX;
 331                         }
 332
 333                         if(_XReal+_WReal>_Parent->getW())
 334                         {
 335                                 _X-= _XReal+_WReal-_Parent->getW();
 336                                 clipped =true;
 337                         }
 338                         else
 339                         {
 340                                 if ((!SpawnOnMousePos) && (_XReal>=0))
 341                                         _X = _MouseDeltaX;
 342                         }
 343
 344                         if(_YReal<0)
 345                         {
 346                                 _Y+= -_YReal;
 347                                 clipped =true;
 348                         }
 349                         else
 350                         {
 351                                 if (!SpawnOnMousePos)
 352                                         _Y = _MouseDeltaY;
 353                         }
 354
 355                         if(_YReal+_HReal>_Parent->getH())
 356                         {
 357                                 _Y-= _YReal+_HReal-_Parent->getH();
 358                                 clipped =true;
 359                         }
 360                         else
 361                         {
 362                                 if ((!SpawnOnMousePos) && (_YReal>=0))
 363                                         _Y = _MouseDeltaY;
 364                         }
 365
 366                         if (clipped)
 367                         {
 368                                 CGroupFrame::updateCoords();
 369                         }
 370                 }
 371         }
 372
 373 }
 374