2003-01-20 16:03:09 +00:00
|
|
|
// new_gui.hxx - XML-configured GUI subsystem.
|
2002-11-08 16:33:00 +00:00
|
|
|
|
2002-11-07 16:27:47 +00:00
|
|
|
#ifndef __NEW_GUI_HXX
|
|
|
|
#define __NEW_GUI_HXX 1
|
|
|
|
|
2003-05-06 23:46:24 +00:00
|
|
|
#include <simgear/props/props.hxx>
|
2003-09-24 17:20:55 +00:00
|
|
|
#include <simgear/structure/subsystem_mgr.hxx>
|
2005-07-18 09:18:24 +00:00
|
|
|
#include <simgear/misc/sg_path.hxx>
|
2002-11-07 16:27:47 +00:00
|
|
|
|
2002-11-07 22:59:46 +00:00
|
|
|
#include <vector>
|
2002-11-07 16:27:47 +00:00
|
|
|
#include <map>
|
2016-12-07 10:03:54 +00:00
|
|
|
#include <memory> // for unique_ptr on some systems
|
2012-09-21 10:34:28 +00:00
|
|
|
#include <cstring> // for strcmp in lstr() (in this header, alas)
|
2005-07-18 09:18:24 +00:00
|
|
|
|
2003-01-16 18:06:27 +00:00
|
|
|
class FGMenuBar;
|
2003-01-18 15:16:34 +00:00
|
|
|
class FGDialog;
|
2005-07-07 21:28:15 +00:00
|
|
|
class FGColor;
|
2005-07-18 09:18:24 +00:00
|
|
|
class FGFontCache;
|
2011-11-19 20:25:51 +00:00
|
|
|
class puFont;
|
2002-11-08 15:24:14 +00:00
|
|
|
|
2003-01-20 16:03:09 +00:00
|
|
|
/**
|
|
|
|
* XML-configured GUI subsystem.
|
|
|
|
*
|
|
|
|
* This subsystem manages the graphical user interface for FlightGear.
|
|
|
|
* It creates a menubar from the XML configuration file in
|
|
|
|
* $FG_ROOT/gui/menubar.xml, then stores the configuration properties
|
2003-02-04 22:28:48 +00:00
|
|
|
* for XML-configured dialog boxes found in $FG_ROOT/gui/dialogs/. It
|
2003-01-20 16:03:09 +00:00
|
|
|
* can show or hide the menubar, and can display any dialog by name.
|
|
|
|
*/
|
2003-09-24 17:20:55 +00:00
|
|
|
class NewGUI : public SGSubsystem
|
2002-11-08 15:24:14 +00:00
|
|
|
{
|
|
|
|
public:
|
2003-01-20 16:03:09 +00:00
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*/
|
2002-11-08 15:24:14 +00:00
|
|
|
NewGUI ();
|
2003-01-20 16:03:09 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Destructor.
|
|
|
|
*/
|
2002-11-08 15:24:14 +00:00
|
|
|
virtual ~NewGUI ();
|
2003-01-20 16:03:09 +00:00
|
|
|
|
2018-04-03 08:41:27 +00:00
|
|
|
// Subsystem API.
|
|
|
|
void bind() override;
|
|
|
|
void init() override;
|
|
|
|
void reinit() override;
|
|
|
|
void shutdown() override;
|
|
|
|
void unbind() override;
|
|
|
|
void update(double delta_time_sec) override;
|
|
|
|
|
|
|
|
// Subsystem identification.
|
2018-05-04 12:18:07 +00:00
|
|
|
static const char* staticSubsystemClassId() { return "gui"; }
|
2002-12-22 19:52:26 +00:00
|
|
|
|
2005-11-09 17:16:59 +00:00
|
|
|
/**
|
|
|
|
* Redraw the GUI picking up new GUI colors.
|
|
|
|
*/
|
|
|
|
virtual void redraw ();
|
|
|
|
|
2003-12-08 02:05:10 +00:00
|
|
|
/**
|
|
|
|
* Creates a new dialog box, using the same property format as the
|
|
|
|
* gui/dialogs configuration files. Does not display the
|
|
|
|
* resulting dialog. If a pre-existing dialog of the same name
|
|
|
|
* exists, it will be deleted. The node argument will be stored
|
|
|
|
* in the GUI subsystem using SGPropertNode_ptr reference counting.
|
|
|
|
* It should not be deleted by user code.
|
|
|
|
*
|
|
|
|
* @param node A property node containing the dialog definition
|
|
|
|
*/
|
|
|
|
virtual void newDialog (SGPropertyNode* node);
|
|
|
|
|
2003-01-20 16:03:09 +00:00
|
|
|
/**
|
|
|
|
* Display a dialog box.
|
|
|
|
*
|
|
|
|
* At initialization time, the subsystem reads all of the XML
|
2003-02-04 22:28:48 +00:00
|
|
|
* configuration files from the directory $FG_ROOT/gui/dialogs/.
|
|
|
|
* The configuration for each dialog specifies a name, and this
|
|
|
|
* method invokes the dialog with the name specified (if it
|
|
|
|
* exists).
|
2003-01-20 16:03:09 +00:00
|
|
|
*
|
|
|
|
* @param name The name of the dialog box.
|
|
|
|
* @return true if the dialog exists, false otherwise.
|
|
|
|
*/
|
2010-09-30 17:58:01 +00:00
|
|
|
virtual bool showDialog (const std::string &name);
|
2003-01-20 16:03:09 +00:00
|
|
|
|
2019-09-08 20:06:41 +00:00
|
|
|
/**
|
|
|
|
* Toggle display of a dialog box.
|
|
|
|
*
|
|
|
|
* @param name The name of the dialog box.
|
|
|
|
* @return true if the dialog is being displayed, false otherwise.
|
|
|
|
*/
|
|
|
|
virtual bool toggleDialog (const std::string &name);
|
|
|
|
|
2003-01-20 16:03:09 +00:00
|
|
|
|
|
|
|
/**
|
2003-12-08 02:05:10 +00:00
|
|
|
* Close the currenty active dialog. This function is intended to
|
|
|
|
* be called from code (pui callbacks, for instance) that registers
|
|
|
|
* its dialog object as active via setActiveDialog(). Other
|
|
|
|
* user-level code should use the closeDialog(name) API.
|
2003-01-20 16:03:09 +00:00
|
|
|
*
|
2003-12-08 02:05:10 +00:00
|
|
|
* @return true if a dialog was active, false otherwise
|
2003-01-20 16:03:09 +00:00
|
|
|
*/
|
|
|
|
virtual bool closeActiveDialog ();
|
|
|
|
|
2003-12-08 02:05:10 +00:00
|
|
|
/**
|
|
|
|
* Close a named dialog, if it is open.
|
|
|
|
*
|
|
|
|
* @param name The name of the dialog box.
|
|
|
|
* @return true if the dialog was active, false otherwise.
|
|
|
|
*/
|
2010-09-30 17:58:01 +00:00
|
|
|
virtual bool closeDialog (const std::string &name);
|
2003-01-20 16:03:09 +00:00
|
|
|
|
2005-10-20 11:15:00 +00:00
|
|
|
/**
|
|
|
|
* Get dialog property tree's root node.
|
|
|
|
* @param name The name of the dialog box.
|
|
|
|
* @return node pointer if the dialog was found, zero otherwise.
|
|
|
|
*/
|
2010-09-30 17:58:01 +00:00
|
|
|
virtual SGPropertyNode_ptr getDialogProperties (const std::string &name);
|
2005-10-20 11:15:00 +00:00
|
|
|
|
2003-01-20 16:03:09 +00:00
|
|
|
/**
|
|
|
|
* Return a pointer to the current menubar.
|
|
|
|
*/
|
2003-01-16 18:06:27 +00:00
|
|
|
virtual FGMenuBar * getMenuBar ();
|
|
|
|
|
2003-01-20 16:03:09 +00:00
|
|
|
/**
|
|
|
|
* Ignore this method.
|
|
|
|
*
|
|
|
|
* This method is for internal use only, but it has to be public
|
|
|
|
* so that a non-class callback can see it.
|
|
|
|
*/
|
|
|
|
virtual void setActiveDialog (FGDialog * dialog);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the dialog currently active, if any.
|
|
|
|
*
|
|
|
|
* @return The active dialog, or 0 if none is active.
|
|
|
|
*/
|
|
|
|
virtual FGDialog * getActiveDialog ();
|
|
|
|
|
2006-04-28 10:27:54 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the named dialog if active.
|
|
|
|
*
|
|
|
|
* @return The named dialog, or 0 if it isn't active.
|
|
|
|
*/
|
2010-09-30 17:58:01 +00:00
|
|
|
virtual FGDialog * getDialog (const std::string &name);
|
2006-04-28 10:27:54 +00:00
|
|
|
|
|
|
|
|
2005-07-18 09:18:24 +00:00
|
|
|
virtual FGColor *getColor (const char * name) const {
|
2005-10-14 16:25:14 +00:00
|
|
|
_citt_t it = _colors.find(name);
|
2005-07-18 10:00:02 +00:00
|
|
|
return (it != _colors.end()) ? it->second : NULL;
|
2005-07-18 09:18:24 +00:00
|
|
|
}
|
2010-09-30 17:58:01 +00:00
|
|
|
virtual FGColor *getColor (const std::string &name) const {
|
2005-10-14 16:25:14 +00:00
|
|
|
_citt_t it = _colors.find(name.c_str());
|
2005-07-18 10:00:02 +00:00
|
|
|
return (it != _colors.end()) ? it->second : NULL;
|
2005-07-18 09:18:24 +00:00
|
|
|
}
|
2005-07-08 20:12:06 +00:00
|
|
|
|
2006-01-26 21:40:37 +00:00
|
|
|
virtual puFont *getDefaultFont() { return _font; }
|
2005-07-07 21:28:15 +00:00
|
|
|
|
2003-01-18 21:11:51 +00:00
|
|
|
protected:
|
2003-01-20 16:03:09 +00:00
|
|
|
/**
|
|
|
|
* Test if the menubar is visible.
|
|
|
|
*
|
|
|
|
* This method exists only for binding.
|
|
|
|
*/
|
2003-01-18 21:11:51 +00:00
|
|
|
virtual bool getMenuBarVisible () const;
|
2003-01-20 16:03:09 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Show or hide the menubar.
|
|
|
|
*
|
|
|
|
* This method exists only for binding.
|
|
|
|
*/
|
2003-01-18 21:11:51 +00:00
|
|
|
virtual void setMenuBarVisible (bool visible);
|
|
|
|
|
2005-07-07 21:28:15 +00:00
|
|
|
virtual void setStyle ();
|
2005-07-13 10:16:42 +00:00
|
|
|
virtual void setupFont (SGPropertyNode *);
|
2002-12-22 19:52:26 +00:00
|
|
|
|
2005-11-09 17:16:59 +00:00
|
|
|
/**
|
|
|
|
* Used by reinit() and redraw() to close all dialogs and to apply
|
|
|
|
* current GUI colors. If "reload" is false, reopens all dialogs.
|
|
|
|
* Otherwise reloads all XML dialog files from disk and reopens all
|
|
|
|
* but Nasal * generated dialogs, omitting dynamic widgets. (This
|
|
|
|
* is only useful for GUI development.)
|
|
|
|
*/
|
|
|
|
virtual void reset (bool reload);
|
|
|
|
|
2017-05-11 07:39:48 +00:00
|
|
|
bool getMenuBarOverlapHide() const;
|
|
|
|
void setMenuBarOverlapHide(bool hide);
|
2018-04-03 10:21:33 +00:00
|
|
|
|
2002-11-08 15:24:14 +00:00
|
|
|
private:
|
2014-01-15 22:00:09 +00:00
|
|
|
void createMenuBarImplementation();
|
2018-04-03 10:21:33 +00:00
|
|
|
|
2005-07-18 11:55:39 +00:00
|
|
|
struct ltstr
|
|
|
|
{
|
|
|
|
bool operator()(const char* s1, const char* s2) const {
|
|
|
|
return strcmp(s1, s2) < 0;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2006-01-26 21:40:37 +00:00
|
|
|
puFont *_font;
|
2011-10-17 16:41:59 +00:00
|
|
|
typedef std::map<const char*,FGColor*, ltstr> ColourDict;
|
|
|
|
ColourDict _colors;
|
|
|
|
typedef ColourDict::iterator _itt_t;
|
|
|
|
typedef ColourDict::const_iterator _citt_t;
|
2002-11-08 15:24:14 +00:00
|
|
|
|
2005-11-09 17:16:59 +00:00
|
|
|
void clear_colors();
|
2003-01-21 15:44:21 +00:00
|
|
|
|
2003-01-20 16:03:09 +00:00
|
|
|
// Read all the configuration files in a directory.
|
2010-10-24 00:09:06 +00:00
|
|
|
void readDir (const SGPath& path);
|
2002-11-08 15:24:14 +00:00
|
|
|
|
2016-12-07 10:03:54 +00:00
|
|
|
std::unique_ptr<FGMenuBar> _menubar;
|
2003-01-20 16:03:09 +00:00
|
|
|
FGDialog * _active_dialog;
|
2014-03-16 22:52:55 +00:00
|
|
|
typedef std::map<std::string,FGDialog *> DialogDict;
|
|
|
|
DialogDict _active_dialogs;
|
2018-04-03 10:21:33 +00:00
|
|
|
|
2012-09-21 09:16:44 +00:00
|
|
|
typedef std::map<std::string, SGPath> NamePathDict;
|
|
|
|
// mapping from dialog names to the corresponding XML property list
|
|
|
|
// which defines them
|
|
|
|
NamePathDict _dialog_names;
|
2018-04-03 10:21:33 +00:00
|
|
|
|
2012-09-21 09:16:44 +00:00
|
|
|
// cache of loaded dialog proeprties
|
|
|
|
typedef std::map<std::string,SGPropertyNode_ptr> NameDialogDict;
|
|
|
|
NameDialogDict _dialog_props;
|
2002-11-08 15:24:14 +00:00
|
|
|
};
|
|
|
|
|
2002-11-07 16:27:47 +00:00
|
|
|
#endif // __NEW_GUI_HXX
|
2002-11-08 16:33:00 +00:00
|
|
|
|