GlobalOptions.hh 21.8 KB
Newer Older
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
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper is distributed in the hope that it will be useful,           *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
 *                                                                           *
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60




//=============================================================================
//
//  Options used throughout the System
//
//=============================================================================

/**
\file GlobalOptions.hh
 * This Header provides access to globally defined variables such as
 * Aplication Directories. You may use these Functions inside your plugins.
*/

#ifndef OPTIONS_HH
#define OPTIONS_HH

Jan Möbius's avatar
Jan Möbius committed
61
#include <OpenFlipper/common/GlobalDefines.hh>
Jan Möbius's avatar
 
Jan Möbius committed
62 63
#include <QDir>
#include <QStringList>
64
#include <QColor>
65
#include <QIcon>
66 67 68 69 70 71 72 73 74
#include <QSettings>

//===========================================================================
/** @name Persistent settings
* @{ */
//===========================================================================

/** \brief QSettings object containing all program settings of OpenFlipper.
*
Jan Möbius's avatar
Jan Möbius committed
75 76
* To get the settings use:\n
* OpenFlipperSettings().value("<Key>").toDouble();\n
77 78
* OpenFlipperSettings().value("<Key>").toBool();
*
Jan Möbius's avatar
Jan Möbius committed
79 80 81
* To change settings do:\n
* OpenFlipperSettings().setValue("<Key>","<Value>");\n
* For detailed info about the values see the documentation of QSettings and the QVariant.\n
82
*
Jan Möbius's avatar
Jan Möbius committed
83
* <b>For each of your plugins, the key has to start with your plugin name!!!</b>
84
*
Jan Möbius's avatar
Jan Möbius committed
85
* The following entries are available through the settings:
86
*
Jan Möbius's avatar
Jan Möbius committed
87
* <b>User Interface Settings</b>
88 89
* * Core/Gui/glViewer/defaultBackgroundColor This controls the default background color of the glViewer (QColor)
* * Core/Gui/glViewer/showControlWheels      This setting controls if the control wheels should be visible in the glViewer (bool)
Jan Möbius's avatar
Jan Möbius committed
90 91 92 93 94
*
* <b>Mouse Controls<b>\n
* * Core/Mouse/Wheel/ZoomFactor       Zoom factor used when turning the mouse wheel (double)\n
* * Core/Mouse/Wheel/ZoomFactorShift  Zoom factor used when turning the mouse wheel while shift is pressed (makes zoom slower while shift is pressed)  (double)\n
*
Jan Möbius's avatar
Jan Möbius committed
95 96 97
* <b>General Stereo Settings<b>\n
* * Core/Stereo/EyeDistance    Distance between eyes. Defaults to 7 cm (double)\n
* * Core/Stereo/FocalDistance  Focal distance. Defaults to center of scene (double)\n
98
* \n
Jan Möbius's avatar
Jan Möbius committed
99 100 101 102 103
* <b>Philips stereo display settings<b>\n
* * Core/Stereo/Philips/Content  Philips stereo header content type (int)\n
* * Core/Stereo/Philips/Factor   Philips stereo header factor (int)\n
* * Core/Stereo/Philips/Offset   Philips stereo header offset cc (int)\n
* * Core/Stereo/Philips/Select   Philips stereo header select (int)\n
104 105 106 107 108 109 110
* \n
* Anaglyph stereo mode settings:\n
*/
QSettings& OpenFlipperSettings();

/** @} */

Jan Möbius's avatar
 
Jan Möbius committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
namespace OpenFlipper {
namespace Options {

/// Returns the base Path of the application
DLLEXPORT
QDir applicationDir();

/// Returns the Path to the Standard Plugins
DLLEXPORT
QDir pluginDir();

/// Returns the Path to the Textures
DLLEXPORT
QDir textureDir();

126 127 128 129
/// Returns the Path to the License files
DLLEXPORT
QDir licenseDir();

Jan Möbius's avatar
Jan Möbius committed
130 131 132 133
/// Returns the Path to the Scripts
DLLEXPORT
QDir scriptDir();

134 135 136 137
/// Returns the Path to the shaders
DLLEXPORT
QDir shaderDir();

Jan Möbius's avatar
 
Jan Möbius committed
138 139 140 141
/// Returns the Path to the Icons
DLLEXPORT
QDir iconDir();

Jan Möbius's avatar
Jan Möbius committed
142 143 144 145
/// Returns the Path to the translation files
DLLEXPORT
QDir translationsDir();

Jan Möbius's avatar
Jan Möbius committed
146 147 148 149
/// Returns the Path to Fonts
DLLEXPORT
QDir fontsDir();

150 151 152 153
/// Returns the Path to the main data directory
DLLEXPORT
QDir dataDir();

Jan Möbius's avatar
 
Jan Möbius committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
/// Returns the base Path of the application
DLLEXPORT
QString applicationDirStr();

/// Returns the Path to the Standard Plugins
DLLEXPORT
QString pluginDirStr();

/// Returns the Path to the Shader directory
DLLEXPORT
QString shaderDirStr();

/// Returns the Path to the Textures
DLLEXPORT
QString textureDirStr();

170 171 172 173
/// Returns the Path to the License files
DLLEXPORT
QString licenseDirStr();

Jan Möbius's avatar
Jan Möbius committed
174 175 176 177
/// Returns the Path to the Scripts
DLLEXPORT
QString scriptDirStr();

Jan Möbius's avatar
 
Jan Möbius committed
178 179 180 181
/// Returns the Path to the Icons
DLLEXPORT
QString iconDirStr();

182 183 184 185
/// Returns the Path to the main data directory
DLLEXPORT
QString dataDirStr();

186 187 188 189
/// Returns the OpenFlipper Icon
DLLEXPORT
QIcon& OpenFlipperIcon();

Jan Möbius's avatar
Jan Möbius committed
190 191 192 193
/// Returns the Path to the translation files
DLLEXPORT
QString translationsDirStr();

Jan Möbius's avatar
Jan Möbius committed
194 195 196 197
/// Returns the Path to Fonts
DLLEXPORT
QString fontsDirStr();

198 199 200 201
/// Returns the Path to Help
DLLEXPORT
QString helpDirStr();

Jan Möbius's avatar
 
Jan Möbius committed
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
//===========================================================================
/** @name Option files / paths
* @{ */
//===========================================================================

  /// Set the list of option files
  DLLEXPORT
  void optionFiles(QStringList _list);

  /// returns a list of all available option files
  DLLEXPORT
  QStringList optionFiles();

  /// Sets the Path to the configuration directory
  DLLEXPORT
  void configDir(QDir _dir);

  /// Sets the Path to the configuration directory
  DLLEXPORT
  bool configDir(QString _dir);

  /// Returns the base Path of the config Dir
  DLLEXPORT
  QString configDirStr();

  /// Returns the base Path of the config Dir
  DLLEXPORT
  QDir configDir();

/** @} */

//===========================================================================
/** @name current status
* @{ */
//===========================================================================

  /// return the current directory
  DLLEXPORT
  QString currentDirStr();

  /// return the current directory
  DLLEXPORT
  QDir currentDir();

  /// Sets the Path to the current directory
  DLLEXPORT
  void currentDir(QDir _dir);

  /// Sets the Path to the current directory
  DLLEXPORT
  bool currentDir(QString _dir);

Dirk Wilden's avatar
Dirk Wilden committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
  /// return the current script-directory
  DLLEXPORT
  QString currentScriptDirStr();

  /// return the current Script-directory
  DLLEXPORT
  QDir currentScriptDir();

  /// Sets the Path to the current Script-directory
  DLLEXPORT
  void currentScriptDir(QDir _dir);

  /// Sets the Path to the current Script-directory
  DLLEXPORT
  bool currentScriptDir(QString _dir);

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289


  /// return the current texture-directory
  DLLEXPORT
  QString currentTextureDirStr();

  /// return the current texture-directory
  DLLEXPORT
  QDir currentTextureDir();

  /// Sets the Path to the current texture-directory
  DLLEXPORT
  void currentTextureDir(QDir _dir);

  /// Sets the Path to the current texture-directory
  DLLEXPORT
  bool currentTextureDir(QString _dir);



Jan Möbius's avatar
 
Jan Möbius committed
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
  /// return last used dataType
  DLLEXPORT
  QString lastDataType();

  /// set the last used dataType
  DLLEXPORT
  void lastDataType(QString _type);

/** @} */

//===========================================================================
/** @name Architecture detection and Architecture specific stuff
* @{ */
//===========================================================================

  DLLEXPORT
  bool is64bit();

  DLLEXPORT
  bool is32bit();

  DLLEXPORT
  bool isLinux();

  DLLEXPORT
  bool isWindows();

317 318 319
  DLLEXPORT
  bool isDarwin();

Jan Möbius's avatar
 
Jan Möbius committed
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
  /// Returns the right separator String for this architecture ( Linux: "/" Windows: "\" )
  DLLEXPORT
  QString dirSeparator();

/** @} */

//===========================================================================
/** @name Environment
* @{ */
//===========================================================================

  /// Returns the LANG environment variable string
  DLLEXPORT
  QString lang();

335 336 337 338 339 340 341 342
  /// Returns the translation language (locale, de_DE, en_US)
  DLLEXPORT
  QString translation();

  /// Set the translation language (locale, de_DE, en_US)
  DLLEXPORT
  void translation(QString _translation);

Jan Möbius's avatar
 
Jan Möbius committed
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
/** @} */

//===========================================================================
/** @name Experience level  of user
* @{ */
//===========================================================================
  enum Experience {
    NOVICE,
    ADVANCED,
    EXPERT
  };

  /// Get experience level
  DLLEXPORT
  Experience getExperience();

  /// Set experience level
  DLLEXPORT
  void setExperience( Experience _exp );

/** @} */

//===========================================================================
/** @name Visualization Control
* @{ */
//===========================================================================

  /// Store if a gui should be visible or not
  DLLEXPORT
  void nogui( bool _nogui );

  /// get if a gui should be visible or not
  DLLEXPORT
  bool nogui( );

  /// get if a gui should be visible or not
  DLLEXPORT
  bool gui( );
381

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
382
  /// Store stereo support setting
Jan Möbius's avatar
 
Jan Möbius committed
383 384 385
  DLLEXPORT
  void stereo( bool _stereo );

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
386
  /// get current stereo support setting
Jan Möbius's avatar
 
Jan Möbius committed
387 388 389
  DLLEXPORT
  bool stereo( );

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
390 391 392 393
  /// Stereo mode
  enum StereoMode {
    OpenGL,
    AnaglyphRedCyan,
394 395
    AnaglyphCustom,
    Philips
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
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
  };

  /// Store opengl stereo support setting
  DLLEXPORT
  void glStereo( bool _stereo );

  /// will be set in core is opengl stereo is supported
  DLLEXPORT
  bool glStereo( );

  /// Store stereo mode setting
  DLLEXPORT
  void stereoMode( StereoMode _mode );

  /// get current stereo mode setting
  DLLEXPORT
  StereoMode stereoMode( );

  /// Store the 3x3 left eye color matrix values for custom anaglyph stereo mode
  DLLEXPORT
  void anaglyphLeftEyeColorMatrix( std::vector<float> _mat );

  /// get the 3x3 left eye color matrix values for custom anaglyph stereo mode
  DLLEXPORT
  std::vector<float> anaglyphLeftEyeColorMatrix( );

  /// Store the 3x3 right eye color matrix values for custom anaglyph stereo mode
  DLLEXPORT
  void anaglyphRightEyeColorMatrix( std::vector<float> _mat );

  /// get the 3x3 right eye color matrix values for custom anaglyph stereo mode
  DLLEXPORT
  std::vector<float> anaglyphRightEyeColorMatrix( );

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
430 431 432 433 434 435 436 437
  /// Enables/Disables mouse cursor depth picking during stereo mode
  DLLEXPORT
  void stereoMousePick( bool _stereoPick );

  /// mouse cursor depth picking during stereo mode
  DLLEXPORT
  bool stereoMousePick( );

Dirk Wilden's avatar
 
Dirk Wilden committed
438 439 440 441 442 443 444 445
  /// Store synchronization setting
  DLLEXPORT
  void synchronization( bool _synchronization );

  /// get current synchronization setting
  DLLEXPORT
  bool synchronization( );

446 447 448 449 450 451 452
  /// Store restrictFrameRate setting
  DLLEXPORT
  void restrictFrameRate( bool _enable );

  /// get restrictFrameRate setting
  DLLEXPORT
  bool restrictFrameRate( );
453

454 455 456 457 458 459 460 461
  /// Store maxFrameRate setting
  DLLEXPORT
  void maxFrameRate( int _fps );

  /// get maxFrameRate setting
  DLLEXPORT
  int maxFrameRate( );

462
  /// Store defaultDrawMode setting
463
  DLLEXPORT
464
  void defaultDrawMode( uint _mode, int _viewer );
465

466
  /// get defaultDrawMode setting
467
  DLLEXPORT
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  uint defaultDrawMode( int _viewer );

  /// Store defaultProjectionMode setting
  DLLEXPORT
  void defaultProjectionMode( int _mode, int _viewer );

  /// get defaultProjectionMode setting
  DLLEXPORT
  int defaultProjectionMode( int _viewer );

  /// Store defaultViewingDirection setting
  DLLEXPORT
  void defaultViewingDirection( int _mode, int _viewer );

  /// get defaultViewingDirection setting
  DLLEXPORT
  int defaultViewingDirection( int _viewer );
485

486 487 488 489 490 491 492 493
  /// Store defaultViewerLayout setting
  DLLEXPORT
  void defaultViewerLayout( int _layout );

  /// get defaultViewerLayout setting
  DLLEXPORT
  int defaultViewerLayout();

Dirk Wilden's avatar
Dirk Wilden committed
494 495 496 497 498 499 500 501
  /// Store disableRedraw setting
  DLLEXPORT
  void redrawDisabled( bool disable );

  /// get disableRedraw setting
  DLLEXPORT
  bool redrawDisabled( );

502 503 504 505 506 507 508 509
  /// Get the flag if a drawMode Menu should always be visible in the context menu
  DLLEXPORT
  bool drawModesInContextMenu();

  /// Set the flag if a drawMode Menu should always be visible in the context menu
  DLLEXPORT
  void drawModesInContextMenu(bool _show);

510 511 512 513 514 515 516 517
  /// Get the flag if a grid should be drawn in every viewer
  DLLEXPORT
  bool gridVisible();

  /// Set the flag if a grid should be drawn in every viewer
  DLLEXPORT
  void gridVisible(bool _visible);

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
518 519 520 521 522 523 524 525
  /// Store Gl based cursor painting
  DLLEXPORT
  void glMouse( bool _glMouse );

  /// Should the mouse cursor be painted with gl
  DLLEXPORT
  bool glMouse( );

Jan Möbius's avatar
 
Jan Möbius committed
526 527 528 529 530 531 532
/** @} */

//===========================================================================
/** @name GUI Control
* @{ */
//===========================================================================

533 534 535 536 537 538 539 540 541 542 543 544
  /// Use multiview Mode?
  DLLEXPORT
  void multiView( bool _multiView);

  /// Use multiview Mode?
  DLLEXPORT
  bool multiView();

  /// Number of examiner widgets
  DLLEXPORT
  unsigned int examinerWidgets();

Jan Möbius's avatar
Jan Möbius committed
545 546 547 548 549 550 551 552
  /// State of the logging widget
  enum LoggerState {
    InScene,
    Normal,
    Hidden
  };

  /// Set the logging widget state
Jan Möbius's avatar
 
Jan Möbius committed
553
  DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
554
  void loggerState( LoggerState _state);
Jan Möbius's avatar
 
Jan Möbius committed
555

Jan Möbius's avatar
Jan Möbius committed
556
  /// What is the current state of the logging widget?
Jan Möbius's avatar
 
Jan Möbius committed
557
  DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
558
  LoggerState loggerState( );
Jan Möbius's avatar
 
Jan Möbius committed
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

  /// Set if we start the toolbox widget closed
  DLLEXPORT
  void hideToolbox( bool _hide);

  /// Start the toolbox widget closed?
  DLLEXPORT
  bool hideToolbox( );

  /// Start fullscreen Mode?
  DLLEXPORT
  void fullScreen( bool _fs );

  /// Start fullscreen Mode?
  DLLEXPORT
  bool fullScreen( );

  /// Which mode should be the default for the toolbar?
  DLLEXPORT
  QString defaultToolboxMode( );

  /// Which mode should be the default for the toolbar?
  DLLEXPORT
  void defaultToolboxMode( QString _mode );

  /// Titel of the main window
  DLLEXPORT
  QString windowTitle( );

  /// Set title of the main window
  DLLEXPORT
  void windowTitle( QString _titel );

  /// Display splash screen?
  DLLEXPORT
  void splash( bool _splash );

  /// Display splash screen?
  DLLEXPORT
  bool splash( );

600
  /// Default base color
601 602 603 604 605 606 607
  DLLEXPORT
  void defaultBaseColor( QColor _color );

  /// Default base color
  DLLEXPORT
  QColor defaultBaseColor();

608
  /// use randomized base color
609 610 611
  DLLEXPORT
  void randomBaseColor(bool _random);

612
  /// use randomized base color
613 614 615
  DLLEXPORT
  bool randomBaseColor();

Jan Möbius's avatar
 
Jan Möbius committed
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
/** @} */

//===========================================================================
/** @name Scripting Options
 * @{ */
//===========================================================================

  /** Scripting status. If this flag is set to true,
   * you should not call functions for multiple objects. Or do
   * remote procedure calls to functions which add scripting commands.
   * As this might call functions twice when executed via scripts. See the
   * scripting plugin for additional information
   */
  DLLEXPORT
  bool scripting( );

  /** Toggle scripting status (normally done by the Scripting plugin only)
   */
  DLLEXPORT
  void scripting(bool _status );

  /** @} */

//===========================================================================
/** @name Logging Options
 * @{ */
//===========================================================================

  /// Log to console output?
  DLLEXPORT
  bool logToConsole( );

  /// Log to console output?
  DLLEXPORT
  void logToConsole(bool _logToConsole );

  /// Give extra debug information
  DLLEXPORT
  bool debug();

  /// Give extra debug information
  DLLEXPORT
  void debug(bool _debug );

Dirk Wilden's avatar
Dirk Wilden committed
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
  /// enable logging to file
  DLLEXPORT
  void logFileEnabled(bool _enable );

  /// is logging to file enabled?
  DLLEXPORT
  bool logFileEnabled();

  /// logfile location (path + filename)
  DLLEXPORT
  void logFile(QString _filename);

  /// logfile location (path + filename)
  DLLEXPORT
  QString logFile();

Jan Möbius's avatar
 
Jan Möbius committed
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
/** @} */

//===========================================================================
/** @name Backup operations
* @{ */
//===========================================================================

  /// Do backups?
  DLLEXPORT
  bool backupEnabled( );

  /// Do backups?
  DLLEXPORT
  void enableBackup(bool _enableBackup );


/** @} */

//===========================================================================
695
/** @name Settings
Jan Möbius's avatar
 
Jan Möbius committed
696 697 698
* @{ */
//===========================================================================

699
  /// currently loading Settings ?
Jan Möbius's avatar
 
Jan Möbius committed
700
  DLLEXPORT
701
  bool loadingSettings( );
Jan Möbius's avatar
 
Jan Möbius committed
702

703
  /// currently loading Settings ?
Jan Möbius's avatar
 
Jan Möbius committed
704
  DLLEXPORT
705
  void loadingSettings(bool _loadingSettings );
Jan Möbius's avatar
 
Jan Möbius committed
706

707 708 709 710 711 712 713
  /// currently saving Settings ?
  DLLEXPORT
  bool savingSettings( );

  /// currently saving Settings ?
  DLLEXPORT
  void savingSettings(bool _savingSettings );
Jan Möbius's avatar
 
Jan Möbius committed
714

Dirk Wilden's avatar
Dirk Wilden committed
715 716 717 718 719 720 721 722
  /// currently loading recent file ?
  DLLEXPORT
  bool loadingRecentFile( );

  /// currently loading recent file ?
  DLLEXPORT
  void loadingRecentFile(bool _loadingRecentFile );

Jan Möbius's avatar
 
Jan Möbius committed
723 724
/** @} */

725 726 727
//===========================================================================
/** @name Core parameters
* @{ */
Jan Möbius's avatar
Jan Möbius committed
728
//===========================================================================
729 730 731

/// Get the argc parameter from the main application
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
732
int* argc();
733 734 735

/// Get the argv parameter from the main application
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
736
char *** argv();
737 738 739

/// Set the argc parameter from the main application ( Dont use it, only called from Core!!)
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
740
void  argc( int* _argc );
741 742 743

/// Set the argv parameter from the main application ( Dont use it, only called from Core!!)
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
744
void argv( char*** _argv);
745

Dirk Wilden's avatar
Dirk Wilden committed
746 747 748
/// is the core remoteControlled?
DLLEXPORT
bool remoteControl();
Jan Möbius's avatar
Jan Möbius committed
749

Dirk Wilden's avatar
Dirk Wilden committed
750 751 752
/// is the core remoteControlled?
DLLEXPORT
void remoteControl( bool _remote );
Jan Möbius's avatar
Jan Möbius committed
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769

//===========================================================================
/** @name Debugging Options
 * @{ */
//===========================================================================

/** If you enable slot debugging, for some slots will be displayed who called them.
 * Currently supported slots are:\n
 * - updateView()
 * - updated_objects( objectId )
 */
DLLEXPORT
void doSlotDebugging( bool _debugging );

DLLEXPORT
bool doSlotDebugging( );

770
/** @} */
Jan Möbius's avatar
 
Jan Möbius committed
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
//===========================================================================
/** @name Update Options
 * @{ */
//===========================================================================

/** Set Server URL to check for updates
 */
DLLEXPORT
void updateUrl( QString _url );

/** Get Server URL to check for updates
 */
DLLEXPORT
QString updateUrl( );

/** Set Username for updates
 */
DLLEXPORT
void updateUsername( QString _username );

/** Get Username for updates
 */
DLLEXPORT
QString updateUsername( );

/** Set Password for updates
 */
DLLEXPORT
void updatePassword( QString _password );

/** Get Password for updates
 */
DLLEXPORT
QString updatePassword( );


/** @} */

//===========================================================================
/** @name Version information
 * @{ */
//===========================================================================

/// Version of OpenFlipper Core
DLLEXPORT
QString coreVersion();

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
/** @} */

//===========================================================================
/** @name Picking Debugger
 * @{ */
//===========================================================================

/** Set rendering Mode for Picking Debugger
 */
DLLEXPORT
void pickingRenderMode( QString _target );

/** Get rendering Mode for Picking Debugger
 */
DLLEXPORT
QString pickingRenderMode( );

/** Enable/Disable Picking Debugger
 */
DLLEXPORT
void renderPicking(bool _enable);

/** Get Picking Debugger state
 */
DLLEXPORT
bool renderPicking( );

846
/** @} */
Jan Möbius's avatar
Jan Möbius committed
847 848 849 850 851

/// Internal function called by the core to connect to the program options
DLLEXPORT 
bool initializeSettings();

852 853 854
/// Internal function called by the core to write the program options on exit
DLLEXPORT 
void closeSettings();
Jan Möbius's avatar
Jan Möbius committed
855

Jan Möbius's avatar
 
Jan Möbius committed
856 857 858 859 860 861
}
}

//=============================================================================
#endif // OPTIONS_HH defined
//=============================================================================