/usr/include/CEGUI/CEGUISystem.h is in libcegui-mk2-dev 0.7.6-3.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 | /***********************************************************************
filename: CEGUISystem.h
created: 20/2/2004
author: Paul D Turner
purpose: Defines interface for main GUI system class
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUISystem_h_
#define _CEGUISystem_h_
#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUISingleton.h"
#include "CEGUIRenderer.h"
#include "CEGUIMouseCursor.h"
#include "CEGUIInputEvent.h"
#include "CEGUIResourceProvider.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4275)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
//! Implementation struct that tracks and controls multiclick for mouse buttons.
struct MouseClickTrackerImpl;
/*!
\brief
The System class is the CEGUI class that provides access to all other elements in this system.
This object must be created by the client application. The System object requires that you pass it
an initialised Renderer object which it can use to interface to whatever rendering system will be
used to display the GUI imagery.
*/
class CEGUIEXPORT System : public Singleton<System>, public EventSet
{
public:
static const String EventNamespace; //!< Namespace for global events
/*************************************************************************
Constants
*************************************************************************/
static const double DefaultSingleClickTimeout; //!< Default timeout for generation of single click events.
static const double DefaultMultiClickTimeout; //!< Default timeout for generation of multi-click events.
static const Size DefaultMultiClickAreaSize; //!< Default allowable mouse movement for multi-click event generation.
// event names
/** Event fired whenever the GUI sheet is changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the @e old GUI sheet (the new one is
* obtained by querying System).
*/
static const String EventGUISheetChanged;
/** Event fired when the single-click timeout is changed.
* Handlers are passed a const reference to a generic EventArgs struct.
*/
static const String EventSingleClickTimeoutChanged;
/** Event fired when the multi-click timeout is changed.
* Handlers are passed a const reference to a generic EventArgs struct.
*/
static const String EventMultiClickTimeoutChanged;
/** Event fired when the size of the multi-click tolerance area is changed.
* Handlers are passed a const reference to a generic EventArgs struct.
*/
static const String EventMultiClickAreaSizeChanged;
/** Event fired when the default font changes.
* Handlers are passed a const reference to a generic EventArgs struct.
*/
static const String EventDefaultFontChanged;
/** Event fired when the default mouse cursor changes.
* Handlers are passed a const reference to a generic EventArgs struct.
*/
static const String EventDefaultMouseCursorChanged;
/** Event fired when the mouse move scaling factor changes.
* Handlers are passed a const reference to a generic EventArgs struct.
*/
static const String EventMouseMoveScalingChanged;
/** Event fired for display size changes (as notified by client code).
* Handlers are passed a const DisplayEventArgs reference with
* DisplayEventArgs::size set to the pixel size that was notifiied to the
* system.
*/
static const String EventDisplaySizeChanged;
/** Event fired when global custom RenderedStringParser is set.
* Handlers are passed a const reference to a generic EventArgs struct.
*/
static const String EventRenderedStringParserChanged;
/*************************************************************************
Construction and Destruction
*************************************************************************/
/*!
\brief
Create the System object and return a reference to it.
\param renderer
Reference to a valid Renderer object that will be used to render GUI
imagery.
\param resourceProvider
Pointer to a ResourceProvider object, or NULL to use whichever default
the Renderer provides.
\param xmlParser
Pointer to a valid XMLParser object to be used when parsing XML files,
or NULL to use a default parser.
\param imageCodec
Pointer to a valid ImageCodec object to be used when loading image
files, or NULL to use a default image codec.
\param scriptModule
Pointer to a ScriptModule object. may be NULL for none.
\param configFile
String object containing the name of a configuration file to use.
\param logFile
String object containing the name to use for the log file.
*/
static System& create(Renderer& renderer,
ResourceProvider* resourceProvider = 0,
XMLParser* xmlParser = 0,
ImageCodec* imageCodec = 0,
ScriptModule* scriptModule = 0,
const String& configFile = "",
const String& logFile = "CEGUI.log");
//! Destroy the System object.
static void destroy();
/*!
\brief
Return a pointer to the Renderer object being used by the system
\return
Pointer to the Renderer object used by the system.
*/
Renderer* getRenderer(void) const {return d_renderer;}
/*!
\brief
Return singleton System object
\return
Singleton System object
*/
static System& getSingleton(void);
/*!
\brief
Return pointer to singleton System object
\return
Pointer to singleton System object
*/
static System* getSingletonPtr(void);
/*!
\brief
Set the default font to be used by the system
\param name
String object containing the name of the font to be used as the system default.
\return
Nothing.
*/
void setDefaultFont(const String& name);
/*!
\brief
Set the default font to be used by the system
\param font
Pointer to the font to be used as the system default.
\return
Nothing.
*/
void setDefaultFont(Font* font);
/*!
\brief
Return a pointer to the default Font for the GUI system
\return
Pointer to a Font object that is the default font in the system.
*/
Font* getDefaultFont(void) const {return d_defaultFont;}
/*!
\brief
Causes a full re-draw next time renderGUI() is called
\return
Nothing
*/
void signalRedraw() {d_gui_redraw = true;}
/*!
\brief
Return a boolean value to indicate whether a full re-draw is requested next time renderGUI() is called.
\return
true if a re-draw has been requested
*/
bool isRedrawRequested() const {return d_gui_redraw;}
/*!
\brief
Render the GUI
Depending upon the internal state, this may either re-use rendering from last time, or trigger a full re-draw from all elements.
\return
Nothing
*/
void renderGUI(void);
/*!
\brief
Set the active GUI sheet (root) window.
\param sheet
Pointer to a Window object that will become the new GUI 'root'
\return
Pointer to the window that was previously set as the GUI root.
*/
Window* setGUISheet(Window* sheet);
/*!
\brief
Return a pointer to the active GUI sheet (root) window.
\return
Pointer to the window object that has been set as the GUI root element.
*/
Window* getGUISheet(void) const {return d_activeSheet;}
/*!
\brief
Return the current timeout for generation of single-click events.
A single-click is defined here as a button being pressed and then released.
\return
double value equal to the current single-click timeout value.
*/
double getSingleClickTimeout(void) const {return d_click_timeout;}
/*!
\brief
Return the current timeout for generation of multi-click events.
A multi-click event is a double-click, or a triple-click. The value returned
here is the maximum allowable time between mouse button down events for which
a multi-click event will be generated.
\return
double value equal to the current multi-click timeout value.
*/
double getMultiClickTimeout(void) const {return d_dblclick_timeout;}
/*!
\brief
Return the size of the allowable mouse movement tolerance used when generating multi-click events.
This size defines an area with the mouse at the centre. The mouse must stay within the tolerance defined
for a multi-click (double click, or triple click) event to be generated.
\return
Size object describing the current multi-click tolerance area size.
*/
const Size& getMultiClickToleranceAreaSize(void) const {return d_dblclick_size;}
/*!
\brief
Set the timeout used for generation of single-click events.
A single-click is defined here as a button being pressed and then
released.
\param timeout
double value equal to the single-click timeout value to be used from now
onwards.
\note
A timeout value of 0 indicates infinity and so no timeout occurrs; as
long as the mouse is in the prescribed area, a mouse button 'clicked'
event will therefore always be raised.
\return
Nothing.
*/
void setSingleClickTimeout(double timeout);
/*!
\brief
Set the timeout to be used for the generation of multi-click events.
A multi-click event is a double-click, or a triple-click. The value
returned here is the maximum allowable time between mouse button down
events for which a multi-click event will be generated.
\param timeout
double value equal to the multi-click timeout value to be used from now
onwards.
\note
A timeout value of 0 indicates infinity and so no timeout occurrs; as
long as the mouse is in the prescribed area, an appropriate mouse button
event will therefore always be raised.
\return
Nothing.
*/
void setMultiClickTimeout(double timeout);
/*!
\brief
Set the size of the allowable mouse movement tolerance used when generating multi-click events.
This size defines an area with the mouse at the centre. The mouse must stay within the tolerance defined
for a multi-click (double click, or triple click) event to be generated.
\param sz
Size object describing the multi-click tolerance area size to be used.
\return
Nothing.
*/
void setMultiClickToleranceAreaSize(const Size& sz);
/*!
\brief
Return whether automatic mouse button click and multi-click (i.e.
double-click and treble-click) event generation is enabled.
\return
- true if mouse button click and multi-click events will be
automatically generated by the system from the basic button up and down
event injections.
- false if no automatic generation of events will occur. In this
instance the user may wish to use the additional event injectors to
manually inform the system of such events.
*/
bool isMouseClickEventGenerationEnabled() const;
/*!
\brief
Set whether automatic mouse button click and multi-click (i.e.
double-click and treble-click) event generation will occur.
\param enable
- true to have mouse button click and multi-click events automatically
generated by the system from the basic button up and down event
injections.
- false if no automatic generation of events should occur. In this
instance the user may wish to use the additional event injectors to
manually inform the system of such events.
*/
void setMouseClickEventGenerationEnabled(const bool enable);
/*!
\brief
Return the currently set default mouse cursor image
\return
Pointer to the current default image used for the mouse cursor. May return NULL if default cursor has not been set,
or has intentionally been set to NULL - which results in a blank default cursor.
*/
const Image* getDefaultMouseCursor(void) const {return d_defaultMouseCursor;}
/*!
\brief
Set the image to be used as the default mouse cursor.
\param image
Pointer to an image object that is to be used as the default mouse cursor. To have no cursor rendered by default, you
can specify NULL here.
\return
Nothing.
*/
void setDefaultMouseCursor(const Image* image);
/*!
\brief
Set the image to be used as the default mouse cursor.
\param image
One of the MouseCursorImage enumerated values.
\return
Nothing.
*/
void setDefaultMouseCursor(MouseCursorImage image) {setDefaultMouseCursor((const Image*)image);}
/*!
\brief
Set the image to be used as the default mouse cursor.
\param imageset
String object that contains the name of the Imageset that contains the image to be used.
\param image_name
String object that contains the name of the Image on \a imageset that is to be used.
\return
Nothing.
\exception UnknownObjectException thrown if \a imageset is not known, or if \a imageset contains no Image named \a image_name.
*/
void setDefaultMouseCursor(const String& imageset, const String& image_name);
/*!
\brief
Return the Window object that the mouse is presently within
\return
Pointer to the Window object that currently contains the mouse cursor, or NULL if none.
*/
Window* getWindowContainingMouse(void) const {return d_wndWithMouse;}
/*!
\brief
Return a pointer to the ScriptModule being used for scripting within the GUI system.
\return
Pointer to a ScriptModule based object.
*/
ScriptModule* getScriptingModule(void) const;
/*!
\brief
Set the ScriptModule to be used for scripting within the GUI system.
\param scriptModule
Pointer to a ScriptModule based object, or 0 for none (be careful!)
\return
Nothing
*/
void setScriptingModule(ScriptModule* scriptModule);
/*!
\brief
Return a pointer to the ResourceProvider being used within the GUI system.
\return
Pointer to a ResourceProvider based object.
*/
ResourceProvider* getResourceProvider(void) const;
/*!
\brief
Execute a script file if possible.
\param filename
String object holding the filename of the script file that is to be executed
\param resourceGroup
Resource group identifier to be passed to the ResourceProvider when loading the script file.
*/
void executeScriptFile(const String& filename, const String& resourceGroup = "") const;
/*!
\brief
Execute a scripted global function if possible. The function should not take any parameters and should return an integer.
\param function_name
String object holding the name of the function, in the global script environment, that
is to be executed.
\return
The integer value returned from the script function.
*/
int executeScriptGlobal(const String& function_name) const;
/*!
\brief
If possible, execute script code contained in the given CEGUI::String object.
\param str
String object holding the valid script code that should be executed.
\return
Nothing.
*/
void executeScriptString(const String& str) const;
/*!
\brief
return the current mouse movement scaling factor.
\return
float value that is equal to the currently set mouse movement scaling factor. Defaults to 1.0f.
*/
float getMouseMoveScaling(void) const;
/*!
\brief
Set the current mouse movement scaling factor
\param scaling
float value specifying the scaling to be applied to mouse movement inputs.
\return
nothing.
*/
void setMouseMoveScaling(float scaling);
/*!
\brief
Internal method used to inform the System object whenever a window is destroyed, so that System can perform any required
housekeeping.
\note
This method is not intended for client code usage. If you use this method anything can, and probably will, go wrong!
*/
void notifyWindowDestroyed(const Window* window);
/*!
\brief
Return the current system keys value.
\return
uint value representing a combination of the SystemKey bits.
*/
uint getSystemKeys(void) const { return d_sysKeys; }
/*!
\brief
Set a new XML parser module to be used.
The current XMLParser will be cleaned up and, if owned by the system,
also deleted, as will any dynamically loaded module associated with the
XMLParser object. The newly created XMLParser object, and the
associated module will be owned by the system.
\param parserName
String object describing the name of the XML parser module to be used.
*/
void setXMLParser(const String& parserName);
/*!
\brief
Sets the XMLParser object to be used by the system.
The current XMLParser will be cleaned up and, if owned by the system,
also deleted, as will any dynamically loaded module associated with the
XMLParser object.
If the argument passed in the \a parser parameter is 0, the system will
cleanup any existing parser as described above, and revert to using
the parser provided by the default module (see getDefaultXMLParserName
and setDefaultXMLParserName).
\param parser
Pointer to the XMLParser object to be used by the system, or 0 to cause
the system to initialise a default parser.
*/
void setXMLParser(XMLParser* parser);
/*!
\brief
Return the XMLParser object.
*/
XMLParser* getXMLParser(void) const { return d_xmlParser; }
/*!
\brief
Set the system default Tooltip object. This value may be NULL to indicate that no default Tooltip will be
available.
\param tooltip
Pointer to a valid Tooltip based object which should be used as the default tooltip for the system, or NULL to
indicate that no system default tooltip is required. Note that when passing a pointer to a Tooltip object,
ownership of the Tooltip does not pass to System.
\return
Nothing.
*/
void setDefaultTooltip(Tooltip* tooltip);
/*!
\brief
Set the system default Tooltip to be used by specifying a Window type.
System will internally attempt to create an instance of the specified window type (which must be
derived from the base Tooltip class). If the Tooltip creation fails, the error is logged and no
system default Tooltip will be available.
\param tooltipType
String object holding the name of the Tooltip based Window type which should be used as the Tooltip for
the system default.
\return
Nothing.
*/
void setDefaultTooltip(const String& tooltipType);
/*!
\brief
return a poiter to the system default tooltip. May return 0.
\return
Pointer to the current system default tooltip. May return 0 if
no system default tooltip is available.
*/
Tooltip* getDefaultTooltip(void) const;
/*!
\brief
Internal method to directly set the current modal target.
\note
This method is called internally by Window, and must be used by client code.
Doing so will most likely not have the expected results.
*/
void setModalTarget(Window* target) {d_modalTarget = target;}
/*!
\brief
Return a pointer to the Window that is currently the modal target.
\return
Pointer to the current modal target. NULL if there is no modal target.
*/
Window* getModalTarget(void) const {return d_modalTarget;}
/*!
\brief
Static member to set the name of the default XML parser module that
should be used.
If you want to modify the default parser from the one compiled in, you
need to call this static member prior to instantiating the main
CEGUI::System object.
Note that calling this member to change the name of the default module
after CEGUI::System, and therefore the default xml parser, has been
created will have no real effect - the default parser name will be
updated, though no actual changes to the xml parser module will occur.
The built-in options for this are:
- XercesParser
- ExpatParser
- LibxmlParser
- TinyXMLParser
Whether these are actually available, depends upon how you built the
system. If you have some custom parser, you can provide the name of
that here to have it used as the default, though note that the
final filename of the parser module should be of the form:
[prefix]CEGUI[parserName][suffix]
where:
- [prefix] is some optional prefix; like 'lib' on linux.
- CEGUI is a required prefix.
- [parserName] is the name of the parser, as supplied to this function.
- [suffix] is the filename suffix, like .dll or .so
Final module filenames are, thus, of the form:
- CEGUIXercesParser.dll
- libCEGUIXercesParser.so
\param parserName
String describing the name of the xml parser module to be used as the
default.
\return
Nothing.
*/
static void setDefaultXMLParserName(const String& parserName);
/*!
\brief
Return the name of the currently set default xml parser module.
\return
String holding the currently set default xml parser name. Note that if
this name has been changed after instantiating the system, the name
returned may not actually correspond to the module in use.
*/
static const String getDefaultXMLParserName();
/*!
\brief
Perform updates with regards to the window that contains the mouse
cursor, firing any required MouseEnters / MouseLeaves events.
\note
The CEGUI system components call this member as a matter of course,
in most cases there will be no need for user / client code to call this
member directly.
\return
- true if the window containing the mouse had changed.
- false if the window containing the mouse had not changed.
*/
bool updateWindowContainingMouse();
/*!
\brief
Retrieve the image codec to be used by the system.
*/
ImageCodec& getImageCodec() const;
/*!
\brief
Set the image codec to be used by the system.
*/
void setImageCodec(const String& codecName);
/*!
\brief
Set the image codec to use from an existing image codec.
In this case the renderer does not take the ownership of the image codec
object.
\param codec
The ImageCodec object to be used.
*/
void setImageCodec(ImageCodec& codec);
/*!
\brief
Set the name of the default image codec to be used.
*/
static void setDefaultImageCodecName(const String& codecName);
/*!
\brief
Get the name of the default image codec.
*/
static const String& getDefaultImageCodecName();
/*!
\brief
Notification function to be called when the main display changes size.
Client code should call this function when the host window changes size,
or if the display resolution is changed in full-screen mode.
Calling this function ensures that any other parts of the system that
need to know about display size changes are notified. This affects
things such as the MouseCursor default constraint area, and also the
auto-scale functioning of Imagesets and Fonts.
\note
This function will also fire the System::EventDisplaySizeChanged event.
\param new_size
Size object describing the new display size in pixels.
*/
void notifyDisplaySizeChanged(const Size& new_size);
/*!
\brief
Return pointer to the currently set global default custom
RenderedStringParser object.
The returned RenderedStringParser is used for all windows that have
parsing enabled and no custom RenderedStringParser set on the window
itself.
If this global custom RenderedStringParser is set to 0, then all windows
with parsing enabled and no custom RenderedStringParser set on the
window itself will use the systems BasicRenderedStringParser.
*/
RenderedStringParser* getDefaultCustomRenderedStringParser() const;
/*!
\brief
Set the global default custom RenderedStringParser object. This change
is reflected the next time an affected window reparses it's text. This
may be set to 0 for no system wide custom parser (which is the default).
The set RenderedStringParser is used for all windows that have
parsing enabled and no custom RenderedStringParser set on the window
itself.
If this global custom RenderedStringParser is set to 0, then all windows
with parsing enabled and no custom RenderedStringParser set on the
window itself will use the systems BasicRenderedStringParser.
*/
void setDefaultCustomRenderedStringParser(RenderedStringParser* parser);
/*!
\brief
Invalidate all imagery and geometry caches for CEGUI managed elements.
This function will invalidate the caches used for both imagery and
geometry for all content that is managed by the core CEGUI manager
objects, causing a full and total redraw of that content. This
includes Window object's cached geometry, rendering surfaces and
rendering windows and the mouse pointer geometry.
*/
void invalidateAllCachedRendering();
/*************************************************************************
Input injection interface
*************************************************************************/
/*!
\brief
Method that injects a mouse movement event into the system
\param delta_x
amount the mouse moved on the x axis.
\param delta_y
amount the mouse moved on the y axis.
\return
- true if the input was processed by the gui system.
- false if the input was not processed by the gui system.
*/
bool injectMouseMove(float delta_x, float delta_y);
/*!
\brief
Method that injects that the mouse has left the application window
\return
- true if the generated mouse move event was handled.
- false if the generated mouse move event was not handled.
*/
bool injectMouseLeaves(void);
/*!
\brief
Method that injects a mouse button down event into the system.
\param button
One of the MouseButton values indicating which button was pressed.
\return
- true if the input was processed by the gui system.
- false if the input was not processed by the gui system.
*/
bool injectMouseButtonDown(MouseButton button);
/*!
\brief
Method that injects a mouse button up event into the system.
\param button
One of the MouseButton values indicating which button was released.
\return
- true if the input was processed by the gui system.
- false if the input was not processed by the gui system.
*/
bool injectMouseButtonUp(MouseButton button);
/*!
\brief
Method that injects a key down event into the system.
\param key_code
uint value indicating which key was pressed.
\return
- true if the input was processed by the gui system.
- false if the input was not processed by the gui system.
*/
bool injectKeyDown(uint key_code);
/*!
\brief
Method that injects a key up event into the system.
\param key_code
uint value indicating which key was released.
\return
- true if the input was processed by the gui system.
- false if the input was not processed by the gui system.
*/
bool injectKeyUp(uint key_code);
/*!
\brief
Method that injects a typed character event into the system.
\param code_point
Unicode code point of the character that was typed.
\return
- true if the input was processed by the gui system.
- false if the input was not processed by the gui system.
*/
bool injectChar(utf32 code_point);
/*!
\brief
Method that injects a mouse-wheel / scroll-wheel event into the system.
\param delta
float value representing the amount the wheel moved.
\return
- true if the input was processed by the gui system.
- false if the input was not processed by the gui system.
*/
bool injectMouseWheelChange(float delta);
/*!
\brief
Method that injects a new position for the mouse cursor.
\param x_pos
New absolute pixel position of the mouse cursor on the x axis.
\param y_pos
New absolute pixel position of the mouse cursoe in the y axis.
\return
- true if the generated mouse move event was handled.
- false if the generated mouse move event was not handled.
*/
bool injectMousePosition(float x_pos, float y_pos);
/*!
\brief
Method to inject time pulses into the system.
\param timeElapsed
float value indicating the amount of time passed, in seconds, since the last time this method was called.
\return
Currently, this method always returns true.
*/
bool injectTimePulse(float timeElapsed);
/*!
\brief
Function to directly inject a mouse button click event.
Here 'click' means a mouse button down event followed by a mouse
button up event.
\note
Under normal, default settings, this event is automatically generated by
the system from the regular up and down events you inject. You may use
this function directly, though you'll probably want to disable the
automatic click event generation first by using the
setMouseClickEventGenerationEnabled function - this setting controls the
auto-generation of events and also determines the default 'handled'
state of the injected click events according to the rules used for
mouse up/down events.
\param button
One of the MouseButton enumerated values.
\return
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
*/
bool injectMouseButtonClick(const MouseButton button);
/*!
\brief
Function to directly inject a mouse button double-click event.
Here 'double-click' means a single mouse button had the sequence down,
up, down within a predefined period of time.
\note
Under normal, default settings, this event is automatically generated by
the system from the regular up and down events you inject. You may use
this function directly, though you'll probably want to disable the
automatic click event generation first by using the
setMouseClickEventGenerationEnabled function - this setting controls the
auto-generation of events and also determines the default 'handled'
state of the injected click events according to the rules used for
mouse up/down events.
\param button
One of the MouseButton enumerated values.
\return
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
*/
bool injectMouseButtonDoubleClick(const MouseButton button);
/*!
\brief
Function to directly inject a mouse button triple-click event.
Here 'triple-click' means a single mouse button had the sequence down,
up, down, up, down within a predefined period of time.
\note
Under normal, default settings, this event is automatically generated by
the system from the regular up and down events you inject. You may use
this function directly, though you'll probably want to disable the
automatic click event generation first by using the
setMouseClickEventGenerationEnabled function - this setting controls the
auto-generation of events and also determines the default 'handled'
state of the injected click events according to the rules used for
mouse up/down events.
\param button
One of the MouseButton enumerated values.
\return
- true if some window or handler reported that it handled the event.
- false if nobody handled the event.
*/
bool injectMouseButtonTripleClick(const MouseButton button);
private:
// unimplemented constructors / assignment
System(const System& obj);
System& operator=(const System& obj);
/*************************************************************************
Implementation Functions
*************************************************************************/
/*!
\brief
Construct a new System object
\param renderer
Reference to a valid Renderer object that will be used to render GUI
imagery.
\param resourceProvider
Pointer to a ResourceProvider object, or NULL to use whichever default
the Renderer provides.
\param xmlParser
Pointer to a valid XMLParser object to be used when parsing XML files,
or NULL to use a default parser.
\param imageCodec
Pointer to a valid ImageCodec object to be used when loading image
files, or NULL to use a default image codec.
\param scriptModule
Pointer to a ScriptModule object. may be NULL for none.
\param configFile
String object containing the name of a configuration file to use.
\param logFile
String object containing the name to use for the log file.
*/
System(Renderer& renderer, ResourceProvider* resourceProvider,
XMLParser* xmlParser, ImageCodec* imageCodec,
ScriptModule* scriptModule, const String& configFile,
const String& logFile);
/*!
\brief
Destructor for System objects.
*/
~System(void);
/*!
\brief
Given Point \a pt, return a pointer to the Window that should receive a mouse input if \a pt is the mouse location.
\param pt
Point object describing a screen location in pixels.
\param allow_disabled
Specifies whether a disabled window may be returned.
\return
Pointer to a Window object that should receive mouse input with the system in its current state and the mouse at location \a pt.
*/
Window* getTargetWindow(const Point& pt, const bool allow_disabled) const;
/*!
\brief
Return a pointer to the Window that should receive keyboard input considering the current modal target.
\return
Pointer to a Window object that should receive the keyboard input.
*/
Window* getKeyboardTargetWindow(void) const;
/*!
\brief
Return a pointer to the next window that is to receive the input if the given Window did not use it.
\param w
Pointer to the Window that just received the input.
\return
Pointer to the next window to receive the input.
*/
Window* getNextTargetWindow(Window* w) const;
/*!
\brief
Translate a MouseButton value into the corresponding SystemKey value
\param btn
MouseButton value describing the value to be converted
\return
SystemKey value that corresponds to the same button as \a btn
*/
SystemKey mouseButtonToSyskey(MouseButton btn) const;
/*!
\brief
Translate a Key::Scan value into the corresponding SystemKey value.
This takes key direction into account, since we map two keys onto one value.
\param key
Key::Scan value describing the value to be converted
\param direction
true if the key is being pressed, false if the key is being released.
\return
SystemKey value that corresponds to the same key as \a key, or 0 if key was not a system key.
*/
SystemKey keyCodeToSyskey(Key::Scan key, bool direction);
//! output the standard log header
void outputLogHeader();
//! adds factories for all the basic window types
void addStandardWindowFactories();
//! create the other core system singleton objects (except the logger)
void createSingletons();
//! cleanup the core system singleton objects
void destroySingletons();
//! handle creation and initialisation of the XML parser.
void setupXMLParser();
//! handle cleanup of the XML parser
void cleanupXMLParser();
//! common function used for injection of mouse positions and movements
bool mouseMoveInjection_impl(MouseEventArgs& ma);
//! setup image codec
void setupImageCodec(const String& codecName);
//! cleanup image codec
void cleanupImageCodec();
//! Set the CEGUI version string that gets output to the log.
void initialiseVersionString();
//! invalidate all windows and any rendering surfaces they may be using.
void invalidateAllWindows();
//! return common ancestor of two windows.
Window* getCommonAncestor(Window* w1, Window* w2);
//! call some function for a chain of windows: (top, bottom]
void notifyMouseTransition(Window* top, Window* bottom,
void (Window::*func)(MouseEventArgs&),
MouseEventArgs& args);
//! create a window of type d_defaultTooltipType for use as the Tooltip
void createSystemOwnedDefaultTooltipWindow() const;
//! destroy the default tooltip window if the system owns it.
void destroySystemOwnedDefaultTooltipWindow();
/*************************************************************************
Handlers for System events
*************************************************************************/
/*!
\brief
Handler called when the main system GUI Sheet (or root window) is changed.
\a e is a WindowEventArgs with 'window' set to the old root window.
*/
void onGUISheetChanged(WindowEventArgs& e);
/*!
\brief
Handler called when the single-click timeout value is changed.
*/
void onSingleClickTimeoutChanged(EventArgs& e);
/*!
\brief
Handler called when the multi-click timeout value is changed.
*/
void onMultiClickTimeoutChanged(EventArgs& e);
/*!
\brief
Handler called when the size of the multi-click tolerance area is changed.
*/
void onMultiClickAreaSizeChanged(EventArgs& e);
/*!
\brief
Handler called when the default system font is changed.
*/
void onDefaultFontChanged(EventArgs& e);
/*!
\brief
Handler called when the default system mouse cursor image is changed.
*/
void onDefaultMouseCursorChanged(EventArgs& e);
/*!
\brief
Handler called when the mouse movement scaling factor is changed.
*/
void onMouseMoveScalingChanged(EventArgs& e);
/*************************************************************************
Implementation Data
*************************************************************************/
Renderer* d_renderer; //!< Holds the pointer to the Renderer object given to us in the constructor
ResourceProvider* d_resourceProvider; //!< Holds the pointer to the ResourceProvider object given to us by the renderer or the System constructor.
bool d_ourResourceProvider;
Font* d_defaultFont; //!< Holds a pointer to the default GUI font.
bool d_gui_redraw; //!< True if GUI should be re-drawn, false if render should re-use last times queue.
Window* d_wndWithMouse; //!< Pointer to the window that currently contains the mouse.
Window* d_activeSheet; //!< The active GUI sheet (root window)
Window* d_modalTarget; //!< Pointer to the window that is the current modal target. NULL is there is no modal target.
String d_strVersion; //!< CEGUI version
uint d_sysKeys; //!< Current set of system keys pressed (in mk1 these were passed in, here we track these ourself).
bool d_lshift; //!< Tracks state of left shift.
bool d_rshift; //!< Tracks state of right shift.
bool d_lctrl; //!< Tracks state of left control.
bool d_rctrl; //!< Tracks state of right control.
bool d_lalt; //!< Tracks state of left alt.
bool d_ralt; //!< Tracks state of right alt.
double d_click_timeout; //!< Timeout value, in seconds, used to generate a single-click (button down then up)
double d_dblclick_timeout; //!< Timeout value, in seconds, used to generate multi-click events (botton down, then up, then down, and so on).
Size d_dblclick_size; //!< Size of area the mouse can move and still make multi-clicks.
MouseClickTrackerImpl* const d_clickTrackerPimpl; //!< Tracks mouse button click generation.
// mouse cursor related
const Image* d_defaultMouseCursor; //!< Image to be used as the default mouse cursor.
// scripting
ScriptModule* d_scriptModule; //!< Points to the scripting support module.
String d_termScriptName; //!< Name of the script to run upon system shutdown.
float d_mouseScalingFactor; //!< Scaling applied to mouse movement inputs.
XMLParser* d_xmlParser; //!< XMLParser object we use to process xml files.
bool d_ourXmlParser; //!< true when we created the xml parser.
DynamicModule* d_parserModule; //! pointer to parser module.
//! System default tooltip object.
mutable Tooltip* d_defaultTooltip;
//! true if System created d_defaultTooltip.
mutable bool d_weOwnTooltip;
//! type of window to create as d_defaultTooltip
String d_defaultTooltipType;
static String d_defaultXMLParserName; //!< Holds name of default XMLParser
//! Holds a pointer to the image codec to use.
ImageCodec* d_imageCodec;
//! true when we created the image codec.
bool d_ourImageCodec;
/** Holds a pointer to the image codec module. If d_imageCodecModule is 0 we
* are not owner of the image codec object
*/
DynamicModule* d_imageCodecModule;
//! Holds the name of the default codec to use.
static String d_defaultImageCodecName;
//! true when we created the CEGUI::Logger based object.
bool d_ourLogger;
//! currently set global RenderedStringParser.
RenderedStringParser* d_customRenderedStringParser;
//! true if mouse click events will be automatically generated.
bool d_generateMouseClickEvents;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUISystem_h_
|