nel/src/gui/ctrl_base_button.cpp

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010-2018  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 // Copyright (C) 2020  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   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 #include "stdpch.h"
  23 #include "nel/gui/ctrl_base_button.h"
  24 #include "nel/misc/xml_auto_ptr.h"
  25 #include "nel/gui/interface_group.h"
  26 #include "nel/gui/lua_ihm.h"
  27 #include "nel/gui/widget_manager.h"
  28 #include "nel/gui/db_manager.h"
  29
  30
  31 using namespace std;
  32 using namespace NLMISC;
  33
  34 #ifdef DEBUG_NEW
  35 #define new DEBUG_NEW
  36 #endif
  37
  38 namespace
  39 {
  40         const uint KEY_REPEAT_MIN = 100;
  41         const uint KEY_REPEAT_MAX = 750;
  42 }
  43
  44 namespace NLGUI
  45 {
  46
  47         sint64 CCtrlBaseButton::_LastLeftClickDate = 0;
  48         NLMISC::CRefPtr<CCtrlBaseButton> CCtrlBaseButton::_LastLeftClickButton;
  49
  50
  51         // ***************************************************************************
  52         CCtrlBaseButton::CCtrlBaseButton(const TCtorParam &param) : CCtrlBase(param), _Type(ToggleButton)
  53         {
  54                 _Pushed = _Over = false;
  55                 _Frozen = false;
  56                 _FrozenHalfTone = true;
  57                 _OverWhenPushed = true;
  58                 _ColorOver = _ColorPushed = _ColorNormal = NLMISC::CRGBA(255,255,255,255);
  59                 _ModulateGlobalColorNormal= _ModulateGlobalColorPushed= _ModulateGlobalColorOver= true;
  60                 _LeftLongClickHandled = true;
  61                 _LeftDblClickHandled = false;
  62                 _ClickWhenPushed = false;
  63                 _RBRefBut = NULL;
  64                 _RBRef = NULL;
  65
  66                 _AHOnOver = NULL;
  67                 _AHOnLeftClick = NULL;
  68                 _AHOnRightClick = NULL;
  69                 _AHOnClockTick = NULL;
  70                 _AHOnLeftLongClick = NULL;
  71                 _AHOnLeftDblClick = NULL;
  72         }
  73
  74         std::string CCtrlBaseButton::getProperty( const std::string &name ) const
  75         {
  76                 if( name == "button_type" )
  77                 {
  78                         return getTypeString();
  79                 }
  80                 else
  81                 if( name == "pushed" )
  82                 {
  83                         return toString( _Pushed );
  84                 }
  85                 else
  86                 if( name == "over_when_pushed" )
  87                 {
  88                         return toString( _OverWhenPushed );
  89                 }
  90                 else
  91                 if( name == "clicked_when_pushed" )
  92                 {
  93                         return toString( _ClickWhenPushed );
  94                 }
  95                 else
  96                 if( name == "color" )
  97                 {
  98                         return getColorAsString();
  99                 }
 100                 else
 101                 if( name == "col_pushed" )
 102                 {
 103                         return getColorPushedAsString();
 104                 }
 105                 else
 106                 if( name == "col_over" )
 107                 {
 108                         return getColorOverAsString();
 109                 }
 110                 else
 111                 if( name == "global_color_normal" )
 112                 {
 113                         return toString( _ModulateGlobalColorNormal );
 114                 }
 115                 else
 116                 if( name == "global_color_pushed" )
 117                 {
 118                         return toString( _ModulateGlobalColorPushed );
 119                 }
 120                 else
 121                 if( name == "global_color_over" )
 122                 {
 123                         return toString( _ModulateGlobalColorOver );
 124                 }
 125                 else
 126                 if( name == "onover" )
 127                 {
 128                         return getAHString( "onover" );
 129                 }
 130                 else
 131                 if( name == "params_over" )
 132                 {
 133                         return _getParamsOnOver();
 134                 }
 135                 else
 136                 if( name == "onclick_l" )
 137                 {
 138                         return getAHString( "onclick_l" );
 139                 }
 140                 else
 141                 if( name == "params_l" )
 142                 {
 143                         return _getParamsOnLeftClick();
 144                 }
 145                 else
 146                 if( name == "ondblclick_l" )
 147                 {
 148                         return getAHString( "ondblclick_l" );
 149                 }
 150                 else
 151                 if( name == "params_dblclick_l" )
 152                 {
 153                         return _AHLeftDblClickParams.toString();
 154                 }
 155                 else
 156                 if( name == "onlongclick_l" )
 157                 {
 158                         return getAHString( "onlongclick_l" );
 159                 }
 160                 else
 161                 if( name == "params_longclick_l" )
 162                 {
 163                         return _AHLeftLongClickParams.toString();
 164                 }
 165                 else
 166                 if( name == "onclick_r" )
 167                 {
 168                         return getAHString( "onclick_r" );
 169                 }
 170                 else
 171                 if( name == "params_r" )
 172                 {
 173                         return _AHRightClickParams.toString();
 174                 }
 175                 else
 176                 if( name == "onclock_tick" )
 177                 {
 178                         return getAHString( "onclock_tick" );
 179                 }
 180                 else
 181                 if( name == "params_clock_tick" )
 182                 {
 183                         return _AHClockTickParams.toString();
 184                 }
 185                 else
 186                 if( name == "menu_l" )
 187                 {
 188                         return _ListMenuLeft.toString();
 189                 }
 190                 else
 191                 if( name == "menu_r" )
 192                 {
 193                         return _ListMenuRight.toString();
 194                 }
 195                 else
 196                 if( name == "menu_b" )
 197                 {
 198                         if( _ListMenuLeft.toString() == _ListMenuRight.toString() )
 199                                 return _ListMenuLeft.toString();
 200                         else
 201                                 return "";
 202                 }
 203                 else
 204                 if( name == "frozen" )
 205                 {
 206                         return toString( _Frozen );
 207                 }
 208                 else
 209                 if( name == "frozen_half_tone" )
 210                 {
 211                         return toString( _FrozenHalfTone );
 212                 }
 213                 else
 214                         return CCtrlBase::getProperty( name );
 215         }
 216
 217         void CCtrlBaseButton::setProperty( const std::string &name, const std::string &value )
 218         {
 219                 if( name == "button_type" )
 220                 {
 221                         setTypeFromString( value );
 222                         return;
 223                 }
 224                 else
 225                 if( name == "pushed" )
 226                 {
 227                         bool b;
 228                         if( fromString( value, b ) )
 229                                 _Pushed = b;
 230                         return;
 231                 }
 232                 else
 233                 if( name == "over_when_pushed" )
 234                 {
 235                         bool b;
 236                         if( fromString( value, b ) )
 237                                 _OverWhenPushed = b;
 238                         return;
 239                 }
 240                 else
 241                 if( name == "clicked_when_pushed" )
 242                 {
 243                         bool b;
 244                         if( fromString( value, b ) )
 245                                 _ClickWhenPushed = b;
 246                         return;
 247                 }
 248                 else
 249                 if( name == "color" )
 250                 {
 251                         setColorAsString( value );
 252                         return;
 253                 }
 254                 else
 255                 if( name == "col_pushed" )
 256                 {
 257                         setColorPushedAsString( value );
 258                         return;
 259                 }
 260                 else
 261                 if( name == "col_over" )
 262                 {
 263                         setColorOverAsString( value );
 264                         return;
 265                 }
 266                 else
 267                 if( name == "global_color_normal" )
 268                 {
 269                         bool b;
 270                         if( fromString( value, b ) )
 271                                 _ModulateGlobalColorNormal = b;
 272                         return;
 273                 }
 274                 else
 275                 if( name == "global_color_pushed" )
 276                 {
 277                         bool b;
 278                         if( fromString( value, b ) )
 279                                 _ModulateGlobalColorPushed = b;
 280                         return;
 281
 282                 }
 283                 else
 284                 if( name == "global_color_over" )
 285                 {
 286                         bool b;
 287                         if( fromString( value, b ) )
 288                                 _ModulateGlobalColorOver = b;
 289                         return;
 290                 }
 291                 else
 292                 if( name == "onover" )
 293                 {
 294                         std::string dummy;
 295                         _AHOnOver = CAHManager::getInstance()->getAH( value, dummy );
 296                         mapAHString( "onover", value );
 297                         return;
 298                 }
 299                 else
 300                 if( name == "params_over" )
 301                 {
 302                         _AHOverParams = value;
 303                         return;
 304                 }
 305                 else
 306                 if( name == "onclick_l" )
 307                 {
 308                         std::string dummy;
 309                         _AHOnLeftClick = CAHManager::getInstance()->getAH( value, dummy );
 310                         mapAHString( "onclick_l", value );
 311                         return;
 312                 }
 313                 else
 314                 if( name == "params_l" )
 315                 {
 316                         _AHLeftClickParams = value;
 317                         return;
 318                 }
 319                 else
 320                 if( name == "ondblclick_l" )
 321                 {
 322                         std::string dummy;
 323                         _AHOnLeftDblClick = CAHManager::getInstance()->getAH( value, dummy );
 324                         mapAHString( "ondblclick_l", value );
 325                         return;
 326                 }
 327                 else
 328                 if( name == "params_dblclick_l" )
 329                 {
 330                         _AHLeftDblClickParams = value;
 331                         return;
 332                 }
 333                 else
 334                 if( name == "onlongclick_l" )
 335                 {
 336                         std::string dummy;
 337                         _AHOnLeftLongClick = CAHManager::getInstance()->getAH( value, dummy );
 338                         mapAHString( "onlongclick_l", value );
 339                         return;
 340                 }
 341                 else
 342                 if( name == "params_longclick_l" )
 343                 {
 344                         _AHLeftLongClickParams = value;
 345                         return;
 346                 }
 347                 else
 348                 if( name == "onclick_r" )
 349                 {
 350                         std::string dummy;
 351                         _AHOnRightClick = CAHManager::getInstance()->getAH( value, dummy );
 352                         mapAHString( "onclick_r", value );
 353                         return;
 354                 }
 355                 else
 356                 if( name == "params_r" )
 357                 {
 358                         _AHRightClickParams = value;
 359                         return;
 360                 }
 361                 else
 362                 if( name == "onclock_tick" )
 363                 {
 364                         std::string dummy;
 365                         _AHOnClockTick = CAHManager::getInstance()->getAH( value, dummy );
 366                         mapAHString( "onclock_tick", value );
 367                         return;
 368                 }
 369                 else
 370                 if( name == "params_clock_tick" )
 371                 {
 372                         _AHClockTickParams = value;
 373                         return;
 374                 }
 375                 else
 376                 if( name == "menu_l" )
 377                 {
 378                         _ListMenuLeft = value;
 379                         return;
 380                 }
 381                 else
 382                 if( name == "menu_r" )
 383                 {
 384                         _ListMenuRight = value;
 385                         return;
 386                 }
 387                 else
 388                 if( name == "menu_b" )
 389                 {
 390                         _ListMenuLeft = _ListMenuRight = value;
 391                         return;
 392                 }
 393                 else
 394                 if( name == "frozen" )
 395                 {
 396                         bool b;
 397                         if( fromString( value, b ) )
 398                                 _Frozen = b;
 399                         return;
 400                 }
 401                 else
 402                 if( name == "frozen_half_tone" )
 403                 {
 404                         bool b;
 405                         if( fromString( value, b ) )
 406                                 _FrozenHalfTone = b;
 407                         return;
 408                 }
 409                 else
 410                         CCtrlBase::setProperty( name, value );
 411         }
 412
 413
 414         xmlNodePtr CCtrlBaseButton::serialize( xmlNodePtr parentNode, const char *type ) const
 415         {
 416                 xmlNodePtr node = CCtrlBase::serialize( parentNode, type );
 417                 if( node == NULL )
 418                         return NULL;
 419
 420                 xmlSetProp( node, BAD_CAST "type", BAD_CAST "button" );
 421                 xmlNewProp( node, BAD_CAST "button_type", BAD_CAST getTypeString().c_str() );
 422                 xmlNewProp( node, BAD_CAST "pushed", BAD_CAST toString( _Pushed ).c_str() );
 423                 xmlNewProp( node, BAD_CAST "over_when_pushed", BAD_CAST toString( _OverWhenPushed ).c_str() );
 424                 xmlNewProp( node, BAD_CAST "clicked_when_pushed", BAD_CAST toString( _ClickWhenPushed ).c_str() );
 425                 xmlNewProp( node, BAD_CAST "color", BAD_CAST getColorAsString().c_str() );
 426                 xmlNewProp( node, BAD_CAST "col_pushed", BAD_CAST getColorPushedAsString().c_str() );
 427                 xmlNewProp( node, BAD_CAST "col_over", BAD_CAST getColorOverAsString().c_str() );
 428                 xmlNewProp( node, BAD_CAST "global_color_normal", BAD_CAST toString( _ModulateGlobalColorNormal ).c_str() );
 429                 xmlNewProp( node, BAD_CAST "global_color_pushed", BAD_CAST toString( _ModulateGlobalColorPushed ).c_str() );
 430                 xmlNewProp( node, BAD_CAST "global_color_over", BAD_CAST toString( _ModulateGlobalColorOver ).c_str() );
 431
 432                 xmlNewProp( node, BAD_CAST "onover", BAD_CAST getAHString( "onover" ).c_str() );
 433                 xmlNewProp( node, BAD_CAST "params_over", BAD_CAST _getParamsOnOver().c_str() );
 434                 xmlNewProp( node, BAD_CAST "onclick_l", BAD_CAST getAHString( "onclick_l" ).c_str() );
 435                 xmlNewProp( node, BAD_CAST "params_l", BAD_CAST _getParamsOnLeftClick().c_str() );
 436                 xmlNewProp( node, BAD_CAST "ondblclick_l", BAD_CAST getAHString( "ondblclick_l" ).c_str() );
 437                 xmlNewProp( node, BAD_CAST "params_dblclick_l", BAD_CAST _AHLeftDblClickParams.toString().c_str() );
 438                 xmlNewProp( node, BAD_CAST "onlongclick_l", BAD_CAST getAHString( "onlongclick_l" ).c_str() );
 439                 xmlNewProp( node, BAD_CAST "params_longclick_l", BAD_CAST _AHLeftLongClickParams.toString().c_str() );
 440                 xmlNewProp( node, BAD_CAST "onclick_r", BAD_CAST getAHString( "onclick_r" ).c_str() );
 441                 xmlNewProp( node, BAD_CAST "params_r", BAD_CAST _AHRightClickParams.toString().c_str() );
 442                 xmlNewProp( node, BAD_CAST "onclock_tick", BAD_CAST getAHString( "onclock_tick" ).c_str() );
 443                 xmlNewProp( node, BAD_CAST "params_clock_tick", BAD_CAST _AHClockTickParams.toString().c_str() );
 444
 445
 446                 xmlNewProp( node, BAD_CAST "menu_l", BAD_CAST _ListMenuLeft.toString().c_str() );
 447                 xmlNewProp( node, BAD_CAST "menu_r", BAD_CAST _ListMenuRight.toString().c_str() );
 448
 449                 if( _ListMenuLeft.toString() == _ListMenuRight.toString() )
 450                         xmlNewProp( node, BAD_CAST "menu_b", BAD_CAST _ListMenuLeft.toString().c_str() );
 451                 else
 452                         xmlNewProp( node, BAD_CAST "menu_b", BAD_CAST "" );
 453
 454                 xmlNewProp( node, BAD_CAST "frozen", BAD_CAST toString( _Frozen ).c_str() );
 455                 xmlNewProp( node, BAD_CAST "frozen_half_tone", BAD_CAST toString( _FrozenHalfTone ).c_str() );
 456
 457                 return node;
 458         }
 459
 460
 461         // ***************************************************************************
 462         bool CCtrlBaseButton::parse (xmlNodePtr cur,CInterfaceGroup * parentGroup)
 463         {
 464                 CXMLAutoPtr prop;
 465
 466                 //try to get props that can be inherited from groups
 467                 //if a property is not defined, try to find it in the parent group.
 468                 //if it is undefined, set it to zero
 469                 if (! CCtrlBase::parse(cur,parentGroup) )
 470                         return false;
 471
 472                 _Over = false;
 473
 474                 // *** try to get the NEEDED specific props
 475                 prop = xmlGetProp (cur, (xmlChar*)"button_type");
 476                 string type;
 477                 if (prop)
 478                 {
 479                         type = (const char*) prop;
 480                 }
 481
 482                 if (type.empty() || type == "toggle_button")
 483                 {
 484                 _Type = ToggleButton;
 485         }
 486         else if (type == "push_button")
 487         {
 488                 _Type = PushButton;
 489         }
 490         else if (type == "radio_button")
 491         {
 492                 _Type = RadioButton;
 493
 494                 initRBRef();
 495                 if (_Pushed)
 496                         *_RBRef = this;
 497         }
 498         else
 499         {
 500                 nlinfo(("cannot parse button type for button " + getId()).c_str());
 501         }
 502
 503                 prop= (char*) xmlGetProp (cur, (xmlChar*)"pushed");
 504                 _Pushed = false;
 505                 if (prop)
 506                         _Pushed = convertBool(prop);
 507
 508                 prop= (char*) xmlGetProp (cur, (xmlChar*)"over_when_pushed");
 509                 _OverWhenPushed = true;
 510                 if (prop)
 511                         _OverWhenPushed = convertBool(prop);
 512
 513                 prop= (char*) xmlGetProp (cur, (xmlChar*)"click_when_pushed");
 514                 _ClickWhenPushed = false;
 515                 if (prop)
 516                         _ClickWhenPushed = convertBool(prop);
 517
 518                 // *** Read Colors
 519                 // get color normal
 520                 prop= (char*) xmlGetProp( cur, (xmlChar*)"color" );
 521                 _ColorNormal = CRGBA(255,255,255,255);
 522                 if (prop)
 523                         _ColorNormal = convertColor (prop);
 524
 525                 // Get ColorPushed
 526                 prop= (char*) xmlGetProp( cur, (xmlChar*)"col_pushed" );
 527                 _ColorPushed = CRGBA(255,255,255,255);
 528                 if (prop)
 529                         _ColorPushed = convertColor(prop);
 530
 531                 // Get ColorOver
 532                 prop= (char*) xmlGetProp( cur, (xmlChar*)"col_over" );
 533                 _ColorOver = CRGBA(255,255,255,255);
 534                 if (prop)
 535                         _ColorOver = convertColor(prop);
 536
 537                 // Default: take "global_color" param interface_element option.
 538                 _ModulateGlobalColorNormal= _ModulateGlobalColorPushed= _ModulateGlobalColorOver= getModulateGlobalColor();
 539
 540                 // Read special global_color for each state
 541                 prop = (char*) xmlGetProp( cur, (xmlChar*)"global_color_normal" );
 542                 if (prop)       _ModulateGlobalColorNormal= convertBool(prop);
 543                 prop = (char*) xmlGetProp( cur, (xmlChar*)"global_color_pushed" );
 544                 if (prop)       _ModulateGlobalColorPushed= convertBool(prop);
 545                 prop = (char*) xmlGetProp( cur, (xmlChar*)"global_color_over" );
 546                 if (prop)       _ModulateGlobalColorOver= convertBool(prop);
 547
 548
 549                 // *** Read Action handlers
 550                 CAHManager::getInstance()->parseAH(cur, "onover", "params_over", _AHOnOver, _AHOverParams);
 551                 CAHManager::getInstance()->parseAH(cur, "onclick_l", "params_l", _AHOnLeftClick, _AHLeftClickParams);
 552                 CAHManager::getInstance()->parseAH(cur, "ondblclick_l", "params_dblclick_l", _AHOnLeftDblClick, _AHLeftDblClickParams);
 553                 CAHManager::getInstance()->parseAH(cur, "onclick_r", "params_r", _AHOnRightClick, _AHRightClickParams);
 554                 CAHManager::getInstance()->parseAH(cur, "onlongclick_l", "params_longclick_l", _AHOnLeftLongClick, _AHLeftLongClickParams);
 555                 CAHManager::getInstance()->parseAH(cur, "onclock_tick", "params_clock_tick", _AHOnClockTick, _AHClockTickParams);
 556
 557                 if( editorMode )
 558                 {
 559                         prop = (char*) xmlGetProp( cur, BAD_CAST "onover" );
 560                         if (prop)
 561                                 mapAHString( "onover", std::string( (const char*)prop ) );
 562
 563                         prop = (char*) xmlGetProp( cur, BAD_CAST "onclick_l" );
 564                         if (prop)
 565                                 mapAHString( "onclick_l", std::string( (const char*)prop ) );
 566
 567                         prop = (char*) xmlGetProp( cur, BAD_CAST "ondblclick_l" );
 568                         if (prop)
 569                                 mapAHString( "ondblclick_l", std::string( (const char*)prop ) );
 570
 571                         prop = (char*) xmlGetProp( cur, BAD_CAST "onclick_r" );
 572                         if (prop)
 573                                 mapAHString( "onclick_r", std::string( (const char*)prop ) );
 574
 575                         prop = (char*) xmlGetProp( cur, BAD_CAST "onlongclick_l" );
 576                         if (prop)
 577                                 mapAHString( "onlongclick_l", std::string( (const char*)prop ) );
 578
 579                         prop = (char*) xmlGetProp( cur, BAD_CAST "onclock_tick" );
 580                         if (prop)
 581                                 mapAHString( "onclock_tick", std::string( (const char*)prop ) );
 582                 }
 583
 584                 // Context menu association
 585                 prop = (char*) xmlGetProp( cur, (xmlChar*)"menu_l" );
 586                 if (prop)
 587                 {
 588                         _ListMenuLeft = NLMISC::toLowerAscii(std::string((const char *) prop));
 589                 }
 590                 prop = (char*) xmlGetProp( cur, (xmlChar*)"menu_r" );
 591                 if (prop)
 592                 {
 593                         _ListMenuRight = NLMISC::toLowerAscii(std::string((const char *) prop));
 594                 }
 595                 // list menu on both clicks
 596                 prop = (char*) xmlGetProp( cur, (xmlChar*)"menu_b" );
 597                 if (prop)
 598                 {
 599                         setListMenuBoth(NLMISC::toLowerAscii(std::string((const char *) prop)));
 600                 }
 601
 602                 prop= (char*) xmlGetProp (cur, (xmlChar*)"frozen");
 603                 _Frozen = false;
 604                 if (prop)
 605                         _Frozen = convertBool(prop);
 606
 607                 prop= (char*) xmlGetProp (cur, (xmlChar*)"frozen_half_tone");
 608                 _FrozenHalfTone = true;
 609                 if (prop)
 610                         _FrozenHalfTone = convertBool(prop);
 611
 612                 return true;
 613         }
 614
 615
 616         // ***************************************************************************
 617         void CCtrlBaseButton::setModulateGlobalColorAll(bool state)
 618         {
 619                 setModulateGlobalColor(state);
 620                 setModulateGlobalColorNormal(state);
 621                 setModulateGlobalColorPushed(state);
 622                 setModulateGlobalColorOver(state);
 623         }
 624
 625
 626         // ***************************************************************************
 627         bool CCtrlBaseButton::handleEvent (const NLGUI::CEventDescriptor& event)
 628         {
 629                 if (CCtrlBase::handleEvent(event)) return true;
 630                 if (!_Active || _Frozen)
 631                         return false;
 632
 633                 sint64 T1 = NLMISC::CTime::getLocalTime();
 634
 635                 if (event.getType() == NLGUI::CEventDescriptor::mouse)
 636                 {
 637                         const NLGUI::CEventDescriptorMouse &eventDesc = (const NLGUI::CEventDescriptorMouse &)event;
 638
 639                         if (eventDesc.getEventTypeExtended() == NLGUI::CEventDescriptorMouse::mouseleftup)
 640                         {
 641                                 if (CWidgetManager::getInstance()->getCapturePointerLeft() != this)
 642                                         return false;
 643                                 _LeftLongClickHandled = true;
 644                         }
 645
 646                         if (!((eventDesc.getX() >= _XReal) &&
 647                                 (eventDesc.getX() < (_XReal + _WReal))&&
 648                                 (eventDesc.getY() > _YReal) &&
 649                                 (eventDesc.getY() <= (_YReal+ _HReal))))
 650                                 return false;
 651
 652                         if (eventDesc.getEventTypeExtended() == NLGUI::CEventDescriptorMouse::mouseleftdown)
 653                         {
 654                                 if (_AHOnLeftDblClick)
 655                                 {
 656                                         if ((CCtrlBaseButton *) _LastLeftClickButton == this && (T1 - _LastLeftClickDate) < CWidgetManager::getInstance()->getUserDblClickDelay())
 657                                         {
 658                                                 CAHManager::getInstance()->runActionHandler (_AHOnLeftDblClick, this, _AHLeftDblClickParams);
 659                                                 _LeftDblClickHandled = true;
 660                                                 _LastLeftClickButton = NULL;
 661                                                 return true;
 662                                         }
 663                                 }
 664
 665                                 if (_AHOnLeftLongClick != NULL)
 666                                 {
 667                                         _LeftLongClickHandled = false;
 668                                         _LeftLongClickDate = T1;
 669                                 }
 670                                 _LeftDblClickHandled = false;
 671                                 _LastLeftClickButton = NULL;
 672                                 return true;
 673                         }
 674
 675                         if (eventDesc.getEventTypeExtended() == NLGUI::CEventDescriptorMouse::mouseleftup)
 676                         {
 677                                 if (CWidgetManager::getInstance()->getCapturePointerLeft() != this)
 678                                         return false;
 679
 680                                 if (_LeftDblClickHandled)  // no effect on mouse up after double click has been handled
 681                                 {
 682                                         _LeftDblClickHandled = false;
 683                                         return true;
 684                                 }
 685
 686                                 // Do not launch 2 times action handler if we are already pushed ! except if we want.
 687                                 if (!_ClickWhenPushed)
 688                                 {
 689                                         if ((_Type == RadioButton) && _RBRef && (*_RBRef == this))
 690                                                 return true;
 691                                 }
 692
 693                                 if (_Type == RadioButton)
 694                                 {
 695                                         _Pushed = true;
 696                                         if(_RBRef)      *_RBRef = this;
 697                                 }
 698
 699                                 if (_Type == ToggleButton)
 700                                         _Pushed = !_Pushed;
 701
 702                                 /*
 703                                 // RunAction
 704                                 if(_AHOnLeftClick != NULL)
 705                                 {
 706                                         //nlinfo("clicked on %s", _Id.c_str());
 707                                         pIM->submitEvent ("button_click:"+getId());//TEMP
 708                                         CAHManager::getInstance()->runActionHandler (_AHOnLeftClick, this, _AHLeftClickParams);
 709                                         //pIM->submitEvent ("button_click:"+getId());
 710                                 }
 711                                 */
 712
 713                                 // top-right corner is EventX=0, EventY=0
 714                                 _EventX = eventDesc.getX() - _XReal;
 715                                 _EventY = (_YReal + _HReal) - eventDesc.getY();
 716
 717                                 runLeftClickAction();
 718                                 if (CWidgetManager::getInstance()->getCapturePointerLeft() == NULL) return true; // event handler may release cpature from this object (if it is removed for example)
 719
 720                                 // Run Menu
 721                                 if (!_ListMenuLeft.empty())
 722                                         CWidgetManager::getInstance()->enableModalWindow (this, _ListMenuLeft);
 723
 724                                 if (_AHOnLeftDblClick != NULL)
 725                                 {
 726                                         _LastLeftClickDate   = T1;
 727                                         _LastLeftClickButton = this;
 728                                 }
 729
 730                                 // Always return true on LeftClick.
 731                                 return true;
 732                         }
 733                         if (eventDesc.getEventTypeExtended() == NLGUI::CEventDescriptorMouse::mouserightdown)
 734                         {
 735                                 _LastLeftClickButton = NULL;
 736                                 return true;
 737                         }
 738                         if (eventDesc.getEventTypeExtended() == NLGUI::CEventDescriptorMouse::mouserightup)
 739                         {
 740                                 _LastLeftClickButton = NULL;
 741                                 bool    handled= false;
 742                                 if (CWidgetManager::getInstance()->getCapturePointerRight() != this)
 743                                         return false;
 744
 745                                 // RunAction
 746                                 if(_AHOnRightClick != NULL)
 747                                 {
 748                                         handled= true;
 749                                         CAHManager::getInstance()->runActionHandler (_AHOnRightClick, this, _AHRightClickParams);
 750                                 }
 751                                 if (CWidgetManager::getInstance()->getCapturePointerRight() == NULL) return true; // if this become NULL, this ctrl has been deleted
 752                                 // Run Menu
 753                                 if (!_ListMenuRight .empty())
 754                                 {
 755                                         handled= true;
 756                                         CWidgetManager::getInstance()->enableModalWindow (this, _ListMenuRight);
 757                                 }
 758                                 // If not handled here, ret to parent
 759                                 return handled;
 760                         }
 761
 762
 763                 }
 764                 else if (event.getType() == NLGUI::CEventDescriptor::system)
 765                 {
 766                         const NLGUI::CEventDescriptorSystem &systemEvent = (const NLGUI::CEventDescriptorSystem &) event;
 767                         if (systemEvent.getEventTypeExtended() == NLGUI::CEventDescriptorSystem::clocktick)
 768                         {
 769                                 if (_AHOnClockTick != NULL)
 770                                 {
 771                                         CAHManager::getInstance()->runActionHandler(_AHOnClockTick, this, _AHClockTickParams);
 772                                 }
 773
 774                                 if (CWidgetManager::getInstance()->getCapturePointerLeft() == this)
 775                                 {
 776                                         if (!_LeftLongClickHandled)
 777                                         {
 778                                                 uint nVal = 50;
 779                                                 CCDBNodeLeaf *pNL = NLGUI::CDBManager::getInstance()->getDbProp("UI:SAVE:KEY_REPEAT_SPEED");
 780                                                 if (pNL != NULL)
 781                                                         nVal = pNL->getValue32();
 782                                                 uint repeatDelay = (uint)(KEY_REPEAT_MIN + (KEY_REPEAT_MAX-KEY_REPEAT_MIN) * (float)nVal / 100.0f);
 783                                                 if ((T1 - _LeftLongClickDate) > repeatDelay)
 784                                                 {
 785                                                         _LeftLongClickHandled = true;
 786                                                         CAHManager::getInstance()->runActionHandler(_AHOnLeftLongClick, this, _AHLeftLongClickParams);
 787                                                 }
 788                                         }
 789                                 }
 790                         }
 791                 }
 792                 return false;
 793         }
 794
 795         std::string CCtrlBaseButton::getTypeString() const
 796         {
 797                 switch( _Type )
 798                 {
 799                 case PushButton:
 800                         return "push_button";
 801                         break;
 802
 803                 case ToggleButton:
 804                         return "toggle_button";
 805                         break;
 806
 807                 case RadioButton:
 808                         return "radio_button";
 809                         break;
 810
 811                 default:
 812                         break;
 813                 }
 814
 815                 return "";
 816         }
 817
 818         void CCtrlBaseButton::setTypeFromString( const std::string &type )
 819         {
 820                 if( type.empty() || type == "toggle_button" )
 821                 {
 822                         _Type = ToggleButton;
 823                         return;
 824                 }
 825                 else
 826                 if( type == "push_button" )
 827                 {
 828                         _Type = PushButton;
 829                         return;
 830                 }
 831                 else
 832                 if( type == "radio_button" )
 833                 {
 834                         _Type = RadioButton;
 835
 836                         initRBRef();
 837                         if( _Pushed )
 838                                 *_RBRef = this;
 839
 840                         return;
 841                 }
 842                 else
 843                 {
 844                         _Type = ToggleButton;
 845                         nlinfo( ( "cannot parse button type for button " + getId() ).c_str() );
 846                 }
 847         }
 848
 849         // ***************************************************************************
 850         void CCtrlBaseButton::initRBRef()
 851         {
 852                 if (_RBRef != NULL) return;
 853                 nlassert(_Parent);
 854                 const vector<CCtrlBase*> &vCB = _Parent->getControls();
 855                 uint i = 0;
 856                 for (i = 0; i < vCB.size(); ++i)
 857                 {
 858                         CCtrlBaseButton *pBut = dynamic_cast<CCtrlBaseButton*>(vCB[i]);
 859                         if (pBut && pBut->_Type == RadioButton)
 860                         {
 861                                 _RBRef = &pBut->_RBRefBut;
 862                                 break;
 863                         }
 864                 }
 865                 // If we are the first radio button of the group and not added
 866                 if (i == vCB.size())
 867                         _RBRef = &this->_RBRefBut;
 868         }
 869
 870         // ***************************************************************************
 871         void CCtrlBaseButton::initRBRefFromRadioButton(CCtrlBaseButton * pBut)
 872         {
 873                 if(pBut && pBut->_Type == RadioButton)
 874                 {
 875                         _RBRef = &(pBut->_RBRefBut);
 876                         _RBRefBut=NULL;
 877                 }
 878         }
 879
 880
 881         // ***************************************************************************
 882         void CCtrlBaseButton::setPushed (bool state)
 883         {
 884                 _Pushed = state;
 885
 886                 if (_Type == RadioButton && _RBRef)
 887                 {
 888                         if (state == true)
 889                         {
 890                                 *_RBRef = this;
 891                         }
 892                         else
 893                         {
 894                                 if (*_RBRef == this)    // I have to be pushed to unpush me
 895                                         *_RBRef = NULL;         // After that : All radio buttons are NOT pushed
 896                         }
 897                 }
 898         }
 899
 900         // ***************************************************************************
 901         void CCtrlBaseButton::setFrozen (bool state)
 902         {
 903                 _Frozen = state;
 904                 if (_Frozen)
 905                 {
 906                         _Pushed = false;
 907                         _Over = false;
 908                 }
 909         }
 910
 911         // ***************************************************************************
 912         void CCtrlBaseButton::setFrozenHalfTone(bool enabled)
 913         {
 914                 _FrozenHalfTone = enabled;
 915         }
 916
 917         // ***************************************************************************
 918         void CCtrlBaseButton::unselect()
 919         {
 920                 if (_Type == RadioButton)
 921                 {
 922                         if (_RBRef) *_RBRef = NULL;
 923                 }
 924         }
 925
 926
 927         // ***************************************************************************
 928         void CCtrlBaseButton::updateOver(bool &lastOver)
 929         {
 930                 if (!CWidgetManager::getInstance()->isMouseHandlingEnabled())
 931                 {
 932                         _Over = false;
 933                         return;
 934                 }
 935
 936                 if (CWidgetManager::getInstance()->getCapturePointerLeft() != NULL)
 937                 {
 938                         if (CWidgetManager::getInstance()->getCapturePointerLeft() != this)
 939                         {
 940                                 _Over = false;
 941                         }
 942                         return;
 943                 }
 944
 945                 const vector<CCtrlBase*> &rVB = CWidgetManager::getInstance()->getCtrlsUnderPointer ();
 946
 947                 if (!_Frozen)
 948                 {
 949                         uint32 i;
 950                         lastOver = _Over;
 951                         // show over if it is the last control that has the same father
 952                         CCtrlBase *candidate = NULL;
 953                         for (i = 0; i < rVB.size(); ++i)
 954                         {
 955                                 if (rVB[i]->getParent() == this->getParent())
 956                                 {
 957                                         candidate = rVB[i];
 958                                 }
 959                         }
 960                         _Over = (candidate == this);
 961                 }
 962                 else
 963                         _Over = false;
 964
 965
 966         }
 967
 968         // ***************************************************************************
 969         void CCtrlBaseButton::elementCaptured(CCtrlBase *capturedElement)
 970         {
 971                 // if not me, then reset my '_Over'
 972                 if (capturedElement != this)
 973                 {
 974                         _Over = false;
 975                 }
 976         }
 977
 978
 979         // ***************************************************************************
 980         void CCtrlBaseButton::runLeftClickAction()
 981         {
 982                 if(_AHOnLeftClick != NULL)
 983                 {
 984
 985                         //nlinfo("clicked on %s", _Id.c_str());
 986                         CAHManager::getInstance()->submitEvent( "button_click:" + getId() );
 987                         CAHManager::getInstance()->runActionHandler (_AHOnLeftClick, this, _AHLeftClickParams);
 988                         //pIM->submitEvent ("button_click:"+getId());
 989                 }
 990         }
 991
 992         // ***************************************************************************
 993         int CCtrlBaseButton::luaRunLeftClickAction(CLuaState &ls)
 994         {
 995                 const char *funcName = "onLeftClick";
 996                 CLuaIHM::checkArgCount(ls, funcName, 0);
 997
 998                 runLeftClickAction();
 999
1000                 return 0;
1001         }
1002
1003                 // ***************************************************************************
1004         void CCtrlBaseButton::runRightClickAction()
1005         {
1006                 if(_AHOnRightClick != NULL)
1007                 {
1008
1009                         CAHManager::getInstance()->submitEvent( "button_click:" + getId() );
1010                         CAHManager::getInstance()->runActionHandler (_AHOnRightClick, this, _AHRightClickParams);
1011                 }
1012         }
1013
1014         // ***************************************************************************
1015         int CCtrlBaseButton::luaRunRightClickAction(CLuaState &ls)
1016         {
1017                 const char *funcName = "onRightClick";
1018                 CLuaIHM::checkArgCount(ls, funcName, 0);
1019
1020                 runRightClickAction();
1021
1022                 return 0;
1023         }
1024
1025 }
1026