diff --git a/osx/dialogxml/button.cpp b/osx/dialogxml/button.cpp index b9046e3a..82e24d3d 100644 --- a/osx/dialogxml/button.cpp +++ b/osx/dialogxml/button.cpp @@ -289,12 +289,10 @@ void cLedGroup::recalcRect(){ frame.inset(-6,-6); } -/** A click handler is called whenever a click is received, even on the currently selected element. */ void cLedGroup::attachClickHandler(click_callback_t f) throw() { onClick = f; } -/** A focus handler is called when the currently selected element changes. */ void cLedGroup::attachFocusHandler(focus_callback_t f) throw() { onFocus = f; } diff --git a/osx/dialogxml/button.h b/osx/dialogxml/button.h index 9ea74a98..3a865796 100644 --- a/osx/dialogxml/button.h +++ b/osx/dialogxml/button.h @@ -9,6 +9,9 @@ #ifndef BUTTON_H #define BUTTON_H +/// @file +/// Button-related classes and types. + #include #include @@ -17,27 +20,35 @@ #include "control.h" #include "graphtool.h" // for eFont +/// A button type. enum eBtnType { // w x h - BTN_SM = 0, // 23x23 (PICT id 2000 / 2001) - BTN_REG, // 63x23 (PICT id 2002 / 2003) - BTN_LG, // 102x23 (PICT id 2004 / 2005) - BTN_HELP, // 16x13 (PICT id 2006 / 2007) white bubble w/ ? mark - BTN_LEFT, // 63x23 (PICT id 2008 / 2009) with left arrow - BTN_RIGHT, // 63x23 (PICT id 2010 / 2011) with right arrow - BTN_UP, // 63x23 (PICT id 2012 / 2013) with up arrow - BTN_DOWN, // 63x23 (PICT id 2014 / 2015) with down arrow - BTN_TINY, // 14x10 (PICT id 2021) - BTN_DONE, // 63x23 (PICT id 2022 / 2023) says "Done" - BTN_TALL, // 63x40 (PICT id 2024 / 2025) - BTN_TRAIT, // 63x40 (PICT id 2026 / 2027) says "Race Good/Bad Traits" - BTN_PUSH, // 30x30 (PICT id 2028 / 2029) red round button - BTN_LED, // 14x10 (PICT id 2018 / 2019 / 2020) + BTN_SM = 0, /**< A small 23x23 button */// (PICT id 2000 / 2001) + BTN_REG, /**< A normal-sized 63x23 button */// (PICT id 2002 / 2003) + BTN_LG, /**< A large 102x23 button */// (PICT id 2004 / 2005) + BTN_HELP, /**< A small 16x13 help button - a white bubble with a ? mark */// (PICT id 2006 / 2007) + BTN_LEFT, /**< A normal-sized 63x23 button with a left-pointing arrow */// (PICT id 2008 / 2009) + BTN_RIGHT, /**< A normal-sized 63x23 button with a right-pointing arrow */// (PICT id 2010 / 2011) + BTN_UP, /**< A normal-sized 63x23 button with an up-pointing arrow */// (PICT id 2012 / 2013) + BTN_DOWN, /**< A normal-sized 63x23 button with a down-pointing arrow */// (PICT id 2014 / 2015) + BTN_TINY, /**< A tiny 14x10 button, same size as an LED */// (PICT id 2021) + BTN_DONE, /**< A normal-sized 63x23 button with "Done" on it */// (PICT id 2022 / 2023) + BTN_TALL, /**< A tall 63x40 button */// (PICT id 2024 / 2025) + BTN_TRAIT, /**< A tall 63x40 button with "Race Good/Bad Traits" on it */// (PICT id 2026 / 2027) + BTN_PUSH, /**< A round red 30x30 push button */// (PICT id 2028 / 2029) + BTN_LED, /**< A tiny 14x10 LED button */// (PICT id 2018 / 2019 / 2020) }; +/// Represents the state of an LED button. +/// Generally, led_red is used to indicate a selected button. +/// Currently, led_green is only used by the spell selection dialog, +/// where led_red indicates the spell is available amd led_green indicates it is selected. enum eLedState {led_green = 0, led_red, led_off}; + +/// A clickable button control. class cButton : public cControl { public: + /// @copydoc cDialog::init() static void init(); void attachClickHandler(click_callback_t f) throw(); void attachFocusHandler(focus_callback_t f) throw(xHandlerNotSupported); @@ -47,8 +58,14 @@ public: short getFormat(eFormat prop) throw(xUnsupportedProp); void setColour(sf::Color clr) throw(xUnsupportedProp); sf::Color getColour() throw(xUnsupportedProp); + /// Set the type of this button. + /// @param newType The desired button type. void setBtnType(eBtnType newType); + /// Get the type of this button. + /// @return The button type. eBtnType getBtnType(); + /// Create a new button. + /// @param parent The parent dialog. explicit cButton(cDialog* parent); bool isClickable(); virtual ~cButton(); @@ -56,8 +73,13 @@ public: cButton& operator=(cButton& other) = delete; cButton(cButton& other) = delete; protected: + /// The type of button. eBtnType type; + /// The click handler. click_callback_t onClick; + /// Construct a new button. + /// @param parent The parent dialog. + /// @param t The type of control. Should be either CTRL_LED or CTRL_BTN. cButton(cDialog* parent,eControlType t); private: bool wrapLabel; @@ -65,13 +87,23 @@ private: std::string fromList; static RECT btnRects[13][2]; protected: + /// The index in buttons of the texture for each button type. static size_t btnGW[14]; + /// The textures that hold the graphics for the buttons. static sf::Texture buttons[7]; }; +/// A LED button that can be either on or off. +/// Additionally, it supports two possible colours, red and green. +/// By default, it behaves like a checkbox, turning on or off when clicked. +/// This default behaviour always assumes a red LED. class cLed : public cButton { public: + /// @copydoc cDialog::init() static void init(); + /// A handler that can be attached as a click handler to prevent the + /// default toggle-selected action of an LED. + /// @return true to indicate the event should continue. static bool noAction(cDialog&,std::string,eKeyMod) {return true;} void attachClickHandler(click_callback_t f) throw(); void attachFocusHandler(focus_callback_t f) throw(); @@ -79,9 +111,15 @@ public: bool triggerFocusHandler(cDialog& me, std::string id, bool losingFocus); void setFormat(eFormat prop, short val) throw(xUnsupportedProp); short getFormat(eFormat prop) throw(xUnsupportedProp); + /// Create a new LED button. + /// @param parent The parent dialog. explicit cLed(cDialog* parent); virtual ~cLed(); + /// Set the LED's current state,. + /// @param to The new state. void setState(eLedState to); + /// Get the LED's current state. + /// @return The current state. eLedState getState(); void draw(); cLed& operator=(cLed& other) = delete; @@ -95,6 +133,24 @@ private: focus_callback_t onFocus; }; +/// A group of LED buttons that behave like radio buttons. +/// As with other standard LEDs, this always assumes red LEDs. +/// +/// When an LED in the group is clicked, the following sequence of events are fired: +/// +/// 1. The click handler of the clicked LED. +/// 2. The click handler of the LED group. +/// 3. The focus handler of the currently selected LED (if any), with the third parameter true. +/// 4. The focus handler of the clicked LED, with the third parameter false. +/// 5. The focus handler of the LED group, with the third parameter false. +/// +/// If at any stage a handler returns false, the entire sequence is aborted, and the +/// selection is not changed. A click within the group's space but not on any choice +/// triggers no events. +/// @note When the focus handlers of the individual LEDs are called, the selection has not yet been updated, +/// so calling the LED group's getSelected() method will still return the previous selection. +/// However, when the focus handler of the LED group is called, the selection _has_ been updated., +/// so getSelected() will return the new selection. (This is the reason for the getPreviousSelection() method.) class cLedGroup : public cControl { std::vector btns; click_callback_t onClick; @@ -106,30 +162,71 @@ class cLedGroup : public cControl { cLedGroup& operator=(cLedGroup& other) = delete; cLedGroup(cLedGroup& other) = delete; public: - void attachClickHandler(click_callback_t f) throw(); // activated whenever a click is received, even on the currently active LED - void attachFocusHandler(focus_callback_t f) throw(); // activated only when the selection changes + /// @copydoc cControl::attachClickHandler() + /// + /// The click handler is called whenever an LED in the group is clicked, even if it's the currently selected LED. + void attachClickHandler(click_callback_t f) throw(); + /// @copydoc cControl::attachFocusHandler() + /// + /// An LED group triggers focus handlers when a choice other than the currently selected one is clicked. + /// The third parameter is always false for an LED group's focus handler. + /// You can determine what changed using getPrevSelection() and getSelected(), and can do whatever post-processing + /// you want, including selecting a completely different option. + void attachFocusHandler(focus_callback_t f) throw(); bool triggerClickHandler(cDialog& me, std::string id, eKeyMod mods); bool triggerFocusHandler(cDialog& me, std::string id, bool losingFocus); + /// Add a new LED to this group. + /// @param ctrl A pointer to the LED, which should already be constructed. + /// @param key A key to be used to look up the LED later. + /// @note This function is intended for internal use, which is why it takes a control pointer instead of a unique key. void addChoice(cLed* ctrl, std::string key); + /// Disable one of the choices in this group. + /// @param id The unique key of the choice. void disable(std::string id); + /// Enable one of the choices in this group. + /// @param id The unique key of the choice. void enable(std::string id); using cControl::show; using cControl::hide; + /// Hide one of the choices in this group. + /// @param id The unique key of the choice. void hide(std::string id); + /// Show one of the choices in this group. + /// @param id The unique key of the choice. void show(std::string id); void setFormat(eFormat prop, short val) throw(xUnsupportedProp); short getFormat(eFormat prop) throw(xUnsupportedProp); void setColour(sf::Color clr) throw(xUnsupportedProp); sf::Color getColour() throw(xUnsupportedProp); + /// Create a new LED group. + /// @param parent The parent dialog. explicit cLedGroup(cDialog* parent); bool isClickable(); bool handleClick(location where); virtual ~cLedGroup(); + /// Get one of the LED's in this group. + /// @param id The unique key of the choice. + /// @return A reference to the LED object. + /// @throw std::invalid_argument if the choice does not exist in the group. cLed& operator[](std::string id); + /// Set the currently selected LED in this group. + /// @param id The unique key of the choice. + /// @throw std::invalid_argument if the choice does not exist in the group. void setSelected(std::string id); + /// Get the currently selected choice. + /// @return id The unique key of the choice. std::string getSelected(); - std::string getPrevSelection(); // The id of the element that was last selected before the selection changed to the current selection. + /// Get the previously selected choice. + /// @return id The unique key of the choice. + /// @note This is intended for use by focus handlers. + /// + /// This refers to the element that was last selected before the selection changed to the current selection. + std::string getPrevSelection(); + /// Recalculate the LED group's bounding rect. + /// Call this after adding choices to the group to ensure that the choice is within the bounding rect. + /// If a choice is not within the bounding rect, it will not respond to clicks. void recalcRect(); + /// A convenience type for making an iterator into the choice map. typedef std::map::iterator ledIter; void draw(); }; diff --git a/osx/dialogxml/control.h b/osx/dialogxml/control.h index 44357689..caa09dde 100644 --- a/osx/dialogxml/control.h +++ b/osx/dialogxml/control.h @@ -9,6 +9,9 @@ #ifndef CONTROL_H #define CONTROL_H +/// @file +/// Control-related classes and types. + #include #include @@ -23,94 +26,217 @@ // short type; //}; +/// Formatting properties enum eFormat { - TXT_FRAME, - TXT_FONT, - TXT_SIZE, - TXT_WRAP, - TXT_FRAMESTYLE, + TXT_FRAME, ///< Whether to draw a frame around the control. Should be a boolean (true or false). + TXT_FONT, ///< The control's text font. Should be one of the constants FONT_PLAIN, FONT_BOLD, FONT_DUNGEON, FONT_MAIDEN. + TXT_SIZE, ///< The control's text size. Should be an integer indicating point size. + TXT_WRAP, ///< Whether the control should wrap. Should be a boolean (true or false). + TXT_FRAMESTYLE, ///< The control's frame style. Should be a boolean (true or false). @see cControl::drawFrame() }; +/// Specifies the type of a control. enum eControlType { CTRL_UNKNOWN, - CTRL_BTN, // An ordinary push button - CTRL_LED, // An LED (checkbox/radiobutton) - CTRL_PICT, // A picture - CTRL_FIELD, // An edit text field - CTRL_TEXT, // A static text object - CTRL_GROUP, // A LED radiobutton-like group - CTRL_STACK, // A group of controls that display pages (not implemented yet) - CTRL_SCROLL,// A scrollbar (not implemented yet) + CTRL_BTN, ///< An ordinary push button + CTRL_LED, ///< An LED (checkbox/radiobutton) + CTRL_PICT, ///< A picture + CTRL_FIELD, ///< An edit text field + CTRL_TEXT, ///< A static text object + CTRL_GROUP, ///< A LED radiobutton-like group + CTRL_STACK, ///< A group of controls that display pages (not implemented yet) + CTRL_SCROLL,///< A scrollbar }; -//typedef bool (*click_callback_t)(cDialog&/*me*/,std::string/*id*/, eKeyMod/*mods*/); -//typedef bool (*focus_callback_t)(cDialog&/*me*/,std::string/*id*/,bool/*losing*/); // losing is true if losing focus, false if gaining focus. +/// The signature of a click handler. typedef std::function click_callback_t; +/// The signature of a focus handler. typedef std::function focus_callback_t; +/// Thrown when you try to set a handler that the control does not support. class xHandlerNotSupported : std::exception { static const char* focusMsg; static const char* clickMsg; bool isFocus; public: + /// Construct a new exception. + /// @param isFocus true to indicate a focus event, false for a click event. xHandlerNotSupported(bool isFocus); + /// @return The error message. const char* what(); }; +/// Thrown when you try to set or retrieve a formatting property that the control does not support. class xUnsupportedProp : std::exception { eFormat whichProp; char* msg; public: + /// Construct a new exception. + /// @param prop The unsupported format property. xUnsupportedProp(eFormat prop) throw(); ~xUnsupportedProp() throw(); + /// @return The error message. const char* what() throw(); }; +/// The superclass of all dialog controls. +/// Some controls can be created in an arbitrary window, rather than a dialog controlled by cDialog. +/// In this case, the event loop of the parent window is responsible for calling draw() when the control needs +/// to be drawn, handleClick() when a mousedown event is received within the control's bounding rect, and +/// triggerClickHandler() if a click occurs, either because handleClick() returns true or because +/// a keyboard event is received that should trigger the control. class cControl { public: + /// Attach a keyboard shortcut to a control. Pressing the keyboard shortcut is equivalent to clicking the control. + /// @param key The desired keyboard shortcut. void attachKey(cKey key); + /// Detach any currently assigned keyboard shortcut from the control. void detachKey(); + /// Set the control's text to a representation of its assigned keyboard shortcut. void setTextToKey(); + /// Check if the control has an assigned keyboard shortcut. + /// @return true if a keyboard shortcut is assigned. bool hasKey(); + /// Retrieve the control's current keyboard shortcut. + /// @return the currently-assigned keyboard shortcut. + /// @note You should first check that a shortcut is assigned using hasKey(). cKey getAttachedKey(); + /// Attach a click handler to this control. + /// @param f The click handler to attach. + /// @throw xHandlerNotSupported if this control does not support click handlers. Most controls do support click handlers. + /// @note Only one click handler can be set at a time. To remove the click handler, set it to null. + /// + /// A click handler must be able to accept three parameters: a reference to the containing dialog, the unique key of the + /// clicked item, and a representation of any modifier keys that are currently held. virtual void attachClickHandler(click_callback_t f) throw(xHandlerNotSupported) = 0; + /// Attach a focus handler to this control. + /// @param f The focus handler to attach. + /// @throw xHandlerNotSupported if this control does not support focus handlers. Most controls do not support focus handlers. + /// @note Only one focus handler can be set at a time. To remove the focus handler, set it to null. + /// + /// A focus handler must be able to accept three parameters: a reference to the containing dialog, the unique key of the + /// clicked item, and a boolean indicating whether focus is being lost or gained; a value of true indicates that + /// focus is being lost, while false indicates it's being gained. Most handlers will only need to act when the + /// third parameter is true. If the handler returns false, the focus change is cancelled. virtual void attachFocusHandler(focus_callback_t f) throw(xHandlerNotSupported) = 0; + /// Trigger the click handler for this control. + /// @param me A reference to the current dialog. + /// @param id The unique key of this control. + /// @param mods The currently-held keyboard modifiers. + /// @return true if the event should continue, false if it should be cancelled. virtual bool triggerClickHandler(cDialog& me, std::string id, eKeyMod mods); + /// Trigger the focus handler for this control. + /// @param me A reference to the current dialog. + /// @param id The unique key of this control. + /// @param losingFocus true if this control is losing focus, false if it is gaining focus. + /// @return true if the event should continue, false if it should be cancelled. virtual bool triggerFocusHandler(cDialog& me, std::string id, bool losingFocus); //virtual void setPict(short pict, short type) = 0; + /// Make this control visible. virtual void show(); // cd_activate_item true + /// Make this control invisible. virtual void hide(); // cd_activate_item false + /// Check if this control is visible. + /// @return true if it's visible bool isVisible(); // cd_get_active + /// Set if this control is active. A control is normally active when the mouse button is held down within its bounding rect. + /// @param active true if it should be active, false if not void setActive(bool active); // "active" here means "selected", so if it's a button, draw it pressed + /// Get the type of this control + /// @return The type of control eControlType getType(); + /// Set the control's text. + /// @param l The new text. virtual void setText(std::string l); + /// Fetch the control's text. + /// @return The control's current text. virtual std::string getText(); + /// Get the bounding rect of this control. + /// @return The control's bounding rect. RECT getBounds(); + /// Set the bounding rect of this control. + /// @param newBounds The new bounding rect. void setBounds(RECT newBounds); + /// Set the position of this control. + /// @param to The new position. void relocate(location to); + /// Get the control's text as an integer. + /// @return The control's text, coerced to an integer. long long getTextAsNum(); + /// Set the control's text to an integer value. + /// @param what The desired value. void setTextToNum(long long what); + /// Set one of the control's formatting parameters. + /// @param prop The parameter to set. + /// @param val The desired value of the parameter. + /// @throw xUnsupportedProp if this control doesn't support the given parameter. virtual void setFormat(eFormat prop, short val) throw(xUnsupportedProp) = 0; + /// Get one of the control's formatting parameters. + /// @param prop The parameter to retrieve. + /// @return The value of the parameter. + /// @throw xUnsupportedProp if this control doesn't support the given parameter. virtual short getFormat(eFormat prop) throw(xUnsupportedProp) = 0; + /// Set the control's colour (usually text colour). + /// @param clr The desired colour. + /// @throw xUnsupportedProp if this control does not support colour. virtual void setColour(sf::Color clr) throw(xUnsupportedProp) = 0; + /// Get the control's colour. + /// @return The current colour. + /// @throw xUnsupportedProp if this control does not support colour. virtual sf::Color getColour() throw(xUnsupportedProp) = 0; + /// Check if the control is clickable. + /// @return true if it's clickable. + /// @note This does not indicate whether the control supports click handlers. + /// In fact, some controls return true only if a click handler is assigned. + /// Others, like editable text fields, are clickable but do not support click handlers. virtual bool isClickable() = 0; + /// Handles the action of clicking this control. + /// @param where The exact location at which the mouse was pressed, relative to the dialog. + /// @return true if the click was successful; false if it was cancelled. + /// + /// This function should implement an event loop and terminate when the mouse button is released. + /// It can be overridden to customize the reaction of the control to mouse events. + /// The default implementation works for a simple clickable object such as a button that + /// should be hilited in some way while pressed and is cancelled by releasing the mouse + /// button outside the control's bounds. virtual bool handleClick(location where); + /// Create a new control attached to an arbitrary window, rather than a dialog. + /// @param t The type of the control. + /// @param p The parent window. cControl(eControlType t, sf::RenderWindow& p); + /// Create a new control attached to a dialog. + /// @param t The type of the control. + /// @param p The parent dialog. cControl(eControlType t, cDialog& p); virtual ~cControl(); + /// Draw the control into its parent window. virtual void draw() = 0; cControl& operator=(cControl& other) = delete; cControl(cControl& other) = delete; protected: + /// The parent dialog of the control. + /// May be null, if the control was created via cControl(eControlType,sf::RenderWindow&). cDialog* parent; + /// The parent window of the control. + /// This is for use in implementing draw(). sf::RenderWindow* inWindow; + /// The control's current text. std::string lbl; - bool visible, depressed = false; // depressed is only applicable for clickable controls + /// Whether the control is visible + bool visible, depressed = false; ///< Whether the control is depressed; only applicable for clickable controls + /// The control's bounding rect. RECT frame; + /// The control's frame style. int frameStyle; + /// The control's attached key. cKey key; + /// Draw a frame around the control. + /// @param amt How much to offset the frame from the control's bounding rect. + /// @param med_or_lt true to use a darker colour for the frame. + /// @note The TXT_FRAMESTYLE formatting property is normally used for the second parameter. void drawFrame(short amt, bool med_or_lt); + /// Redraws the parent dialog, if any. + /// Intended to be called from handleClick(), where there is usually a minor event loop happening. void redraw(); private: eControlType type; diff --git a/osx/dialogxml/dialog.h b/osx/dialogxml/dialog.h index 6bf68073..702a2381 100644 --- a/osx/dialogxml/dialog.h +++ b/osx/dialogxml/dialog.h @@ -9,6 +9,9 @@ #ifndef DIALOG_H #define DIALOG_H +/// @file +/// Dialog-related classes and types. + #include #include @@ -24,10 +27,12 @@ class cControl; class cTextField; +/// Specifies the relative position of a control's labelling text. enum eLabelPos { LABEL_LEFT, LABEL_ABOVE, LABEL_RIGHT, LABEL_BELOW, }; +/// Defines a fancy dialog box with various controls. class cDialog { typedef std::map::iterator ctrlIter; std::map controls; @@ -43,35 +48,113 @@ class cDialog { template void handleTabOrder(std::string& itemHit, Iter begin, Iter end); std::vector> tabOrder; public: + /// Performs essential startup initialization. Generally should not be called directly. static void init(); - static const short BG_LIGHT, BG_DARK; + /// The light background pattern used by the scenario editor dialogs. + static const short BG_LIGHT, BG_DARK; ///< The dark background pattern used by the game dialogs. + /// The default background pattern for newly created dialogs. static short defaultBackground; - explicit cDialog(cDialog* p = NULL); // dialog with no items + /// Create a new dialog with no items. + /// @param p Optionally, a parent dialog. + explicit cDialog(cDialog* p = NULL); + /// Creates a new dialog, loading its definition from a file. + /// @param path The name of the file to load. It must be in the game's dialogs directory. + /// @param p Optionally, a parent dialog. explicit cDialog(std::string path, cDialog* p = NULL); // cd_create_dialog ~cDialog(); // cd_kill_dialog - bool add(cControl* what, RECT ctrl_frame, std::string key); // returns false if the key is used, true if the control was added - bool remove(std::string key); // returns true if the key existed and was removed, false if the key did not exist - bool addLabelFor(std::string key, std::string label, eLabelPos where, short offset, bool bold); // returns true if the label was added + /// Add a new control to the dialog. + /// @param what A pointer to the control, which should already be constructed. + /// @param ctrl_frame The control's bounding rect, which includes its position in the dialog. + /// @param key A key to be used to look up the control later. + /// @return false if the key is used, true if the control was added. + /// @note This function is intended for internal use, which is why it takes a control pointer instead of a unique key. + bool add(cControl* what, RECT ctrl_frame, std::string key); + /// Remove a control from the dialog. + /// @param key The control's unique key. + /// @return true if the key existed and the control was removed, false if the key did not exist + bool remove(std::string key); + /// Add a new static text control, positioned to function as a label for an existing control. + /// @param key The unique key of the control to be labelled. + /// @param label The text of the label. + /// @param where Specifies the position of the label relative to the control. + /// @param offset An offset in pixels between the control and the label. + /// @param bold If true, the label will be bolded. + /// @return true if the label was added, false if not (usually because it already had a label) + bool addLabelFor(std::string key, std::string label, eLabelPos where, short offset, bool bold); + /// Show the dialog and start its event loop. All dialogs are modal. void run(); // cd_run_dialog + /// Get the result of the dialog. + /// @tparam type The result type. + /// @throw boost::bad_any_cast if the provided result type is different from the type set by getResult(). + /// @return The dialog's result. template type getResult(){ return boost::any_cast(result); } + /// Set the result of the dialog. + /// @tparam type The result type. + /// @param val The result value. template void setResult(const type& val){ result = val; } + /// Set the background pattern of the dialog. + /// @param n The numeric index of the background pattern, which should be in the range [0,20]. + /// You can use the constants BG_LIGHT or BG_DARK to reference the most commonly used backgrounds. void setBg(short n); + /// Get the background pattern of the dialog. + /// @return The numeric index of the background pattern. short getBg(); + /// Set the default text colour applied to new dialogs when loading from a file. + /// @param clr The text colour. void setDefTextClr(sf::Color clr); + /// Set the default button, which will be drawn outlined and respond to the enter key. + /// @param defBtn The unique key of the default button. + /// + /// This function does not check that the default button exists and is a button. void setDefBtn(std::string defBtn); + /// Get the default text colour applied to new dialogs when loading from a file. + /// @return The text colour. sf::Color getDefTextClr(); - bool setFocus(cTextField* newFocus, bool force = false); // Setting force = true skips focus handlers + /// Set the focused text field. + /// @param newFocus A pointer to the text field to receive focus. + /// @param force If true, the change will be forced. + /// The focus handlers for both the previously focused text field and the newly focused text field will not be triggered. + /// @return true if the focus changed; if it returns false, it could mean either that the control did not exist in the dialog + /// or that one of the focus handlers prevented the focus change. + /// @note This function is intended for internal use, which is why it takes a control pointer instead of a unique key. + bool setFocus(cTextField* newFocus, bool force = false); + /// Close the dialog. + /// @param triggerFocus true to allow the focus handler of the currently focused text field to prevent the dialog from closing + /// @return true unless the currently focused field prevented the dialog from closing + /// + /// Generally, you would pass true in a handler for an OK button and false in a handler for a Cancel button. bool toast(bool triggerFocus); + /// Get a reference to a control. + /// @param id The unique key of the control. + /// @throw std::invalid_argument if the control does not exist. + /// @return a reference to the requested control. cControl& getControl(std::string id); + /// @copydoc getControl() cControl& operator[](std::string id); + /// Recalculate the dialog's bounding rect. + /// Call this after adding controls to the dialog to ensure that the control is within the bounding rect. void recalcRect(); // TODO: It seems like a bad thing for these two to not use the typedefs... + /// Attach the same click handler to several controls. + /// @param handler The handler to attach. + /// @param controls A list of the unique keys of the controls to which you want the handler attached. + /// @throw xHandlerNotSupported if any of the controls do not support click handlers. + /// @throw std::invalid_argument if any of the controls do not exist. + /// @see cControl::attachClickHandler() void attachClickHandlers(std::function handler, std::vector controls); + /// Attach the same focus handler to several controls. + /// @param handler The handler to attach. + /// @param controls A list of the unique keys of the controls to which you want the handler attached. + /// @throw xHandlerNotSupported if any of the controls do not support focus handlers. + /// @throw std::invalid_argument if any of the controls do not exist. + /// @see cControl::attachFocusHandler() void attachFocusHandlers(std::function handler, std::vector controls); + /// Get the bounding rect of the dialog. + /// @return The dialog's bounding rect. RECT getBounds() {return winRect;} cDialog& operator=(cDialog& other) = delete; cDialog(cDialog& other) = delete; @@ -87,44 +170,78 @@ private: friend class cControl; }; +/// Thrown when an invalid element is found while parsing an XML dialog definition. class xBadNode : std::exception { std::string type, dlg; int row, col; const char* msg; public: + /// Construct a new exception. + /// @param t The tag name of the invalid element. + /// @param r The line number of the element in the source. + /// @param c The column number of the element in the source. + /// @param dlg The name of the file in which the element occurred. xBadNode(std::string t, int r, int c, std::string dlg) throw(); ~xBadNode() throw(); + /// @return The error message. const char* what() throw(); }; +/// Thrown when an invalid attribute is found while parsing an XML dialog definition. class xBadAttr : std::exception { std::string type, name, dlg; int row, col; const char* msg; public: + /// Construct a new exception. + /// @param t The tag name of the element with the invalid attribute. + /// @param n The name of the invalid attribute. + /// @param r The line number of the element in the source. + /// @param c The column number of the element in the source. + /// @param dlg The name of the file in which the element occurred. xBadAttr(std::string t,std::string n, int r, int c, std::string dlg) throw(); ~xBadAttr() throw(); + /// @return The error message. const char* what() throw(); }; +/// Thrown when an element is missing a required attribute while parsing an XML dialog definition. class xMissingAttr : std::exception { std::string type, name, dlg; int row, col; const char* msg; public: + /// Construct a new exception. + /// @param t The tag name of the element with the missing attribute. + /// @param n The name of the missing attribute. + /// @param r The line number of the element in the source. + /// @param c The column number of the element in the source. + /// @param dlg The name of the file in which the element occurred. xMissingAttr(std::string t,std::string n, int r, int c, std::string dlg) throw(); ~xMissingAttr() throw(); + /// @return The error message. const char* what() throw(); }; +/// Thrown when an invalid value is found anywhere within an element's or attribute's content. class xBadVal : std::exception { std::string type, name, val, dlg; int row, col; const char* msg; public: + /// A magic value to indicate errors in an element's content, rather than an attribute's content. static constexpr const char*const CONTENT = ""; + /// Construct a new exception. + /// @param t The tag name of the element with the invalid value. + /// @param n The name of the attribute with the invalid value. + /// You should pass xBadVal::CONTENT if the bad value is within an element's content. + /// @param v The invalid value. + /// @param r The line number of the element in the source. + /// @param c The column number of the element in the source. + /// @param dlg The name of the file in which the element occurred. xBadVal(std::string t,std::string n,std::string v, int r, int c, std::string dlg) throw(); ~xBadVal() throw(); + /// @return The error message. const char* what() throw(); }; diff --git a/osx/dialogxml/dialog.keys.h b/osx/dialogxml/dialog.keys.h index a015c34f..26d2eb76 100644 --- a/osx/dialogxml/dialog.keys.h +++ b/osx/dialogxml/dialog.keys.h @@ -9,15 +9,32 @@ #ifndef BoE_dialog_keys_h #define BoE_dialog_keys_h +/// @file +/// Key-related classes and types. + +/// Keyboard modifiers, as a bit-field-like enumeration. +/// Note that mod_ctrl refers to both the control key and the Mac's command key. +/// It also covers the "meta" key supported in certain other systems, and may +/// also be triggered by the Windows key. +/// +/// Use mod_contains() to check if a specific modifier is set in the bit field. enum eKeyMod { - mod_none = 0, + mod_none = 0, ///< No modifier + /// @{ A single modifier mod_alt = 1, mod_shift = 2, mod_ctrl = 4, + /// @} + /// @{ Two modifiers mod_altshift = mod_alt + mod_shift, mod_altctrl = mod_alt + mod_ctrl, mod_shiftctrl = mod_shift + mod_ctrl, + /// @} + /// All modifiers mod_all = mod_alt + mod_shift + mod_ctrl, }; +/// Representations of special keys. +/// Not all of these represent a literal single keypress. +/// Some refer to common two-keypress keyboard shortcuts. enum eSpecKey { key_left, key_right, key_up, key_down, key_esc, key_enter, key_tab, key_help, // key_help should bind to the help key on Mac and the F1 key on Windows @@ -28,21 +45,47 @@ enum eSpecKey { // This is in addition to the home, end, pgup, pgdn keys triggering these. }; +/// Represents a keypress. struct cKey { + /// If true, it's a special key. Otherwise, a character has been typed. bool spec; union { + /// The character that has been typed. unsigned char c; + /// The special key that was pressed. eSpecKey k; }; + /// A bit field of held key modifiers. eKeyMod mod; }; +/// Combine two key modifiers. +/// @param lhs @param rhs +/// @return lhs + rhs eKeyMod operator + (eKeyMod lhs, eKeyMod rhs); +/// Cancel out a key modifier. +/// @param lhs @param rhs +/// @return lhs - rhs eKeyMod operator - (eKeyMod lhs, eKeyMod rhs); +/// Combine two key modifiers. +/// @param lhs The key modifier set to modify. +/// @param rhs The key modifier to remove. +/// @return lhs, now modified. eKeyMod&operator += (eKeyMod&lhs, eKeyMod rhs); +/// Cancel out a key modifier. +/// @param lhs The key modifier set to modify. +/// @param rhs The key modifier to remove. +/// @return lhs, now modified. eKeyMod&operator -= (eKeyMod&lhs, eKeyMod rhs); +/// Compare two keys. +/// @param a @param b +/// @return Whether they are equal. bool operator== (cKey a, cKey b); +/// Check if haystack contains the modifier specified by needle. +/// @param haystack The set of modifiers to check. +/// @param needle The modifier to check for; generally one of mod_alt, mod_shift, or mod_ctrl. +/// @return true if the needle is in the haystack bool mod_contains(eKeyMod haystack, eKeyMod needle); #endif diff --git a/osx/dialogxml/dlogutil.buttons.h b/osx/dialogxml/dlogutil.buttons.h index 0eddcacc..16ee2c9c 100644 --- a/osx/dialogxml/dlogutil.buttons.h +++ b/osx/dialogxml/dlogutil.buttons.h @@ -6,7 +6,11 @@ * */ -size_t available_btns[53] = { // This array is a list of indices into the following array. +/// @file +/// Preset button specifications for cThreeChoice + +/// The buttons available to special nodes; consists of indices into the basic_buttons array. +size_t available_btns[53] = { 0, 63, 64, 65, 1, 4, 5, 8, 128,9, 10, 11, 12, 13, 14, 15, 16, 17, 29, 51, 60, 61, 62, 66, 69, 70, 71, 72, 73, 74, @@ -15,6 +19,7 @@ size_t available_btns[53] = { // This array is a list of indices into the follow 135,136,137 }; +/// A list of preset button types. Many of these are unused. bbtt basic_buttons[] = { {BTN_DONE, " ", {false,0,mod_none}}, // Formerly DLG_BTN_REG with "Done " as the string {BTN_REG, "Ask", {false,0,mod_none}}, diff --git a/osx/dialogxml/dlogutil.cpp b/osx/dialogxml/dlogutil.cpp index 3d5f4c18..f9aaea18 100644 --- a/osx/dialogxml/dlogutil.cpp +++ b/osx/dialogxml/dlogutil.cpp @@ -536,7 +536,7 @@ void giveError(std::string str1, std::string str2, cDialog* parent){ error.show(); } -void oopsError(short error, short code, short mode){ // mode is 0 for scened, 1 for game, 2 for pced +void oopsError(short error, short code, short mode){ std::ostringstream error_str1, error_str2; static const char* progname[3] = {"the scenario editor", "Blades of Exile", "the PC editor"}; static const char* filetname[3] = {"scenario", "game", "game"}; diff --git a/osx/dialogxml/dlogutil.h b/osx/dialogxml/dlogutil.h index 11bc8ab9..2c4f4791 100644 --- a/osx/dialogxml/dlogutil.h +++ b/osx/dialogxml/dlogutil.h @@ -9,6 +9,9 @@ #ifndef DIALOG_UTIL_H #define DIALOG_UTIL_H +/// @file +/// A set of utility classes for simple and common dialogs. + #include #include #include @@ -19,9 +22,10 @@ #include "button.h" #include -//typedef void (*record_callback_t)(std::string,std::string); +/// The signature of a record handler for cStrDlog. typedef std::function record_callback_t; +/// A simple dialog with one or two long strings, an optional title, and an optional record button. class cStrDlog { static std::string getFileName(short n_strs, ePicType type, bool hasTitle); cDialog dlg; @@ -32,31 +36,75 @@ class cStrDlog { bool onRecord(std::string id); bool onDismiss(); public: + /// Construct a string dialog. + /// @param str1 The first string. + /// @param str2 The second string. If left as an empty string, there will be only one string in the dialog. + /// @param title The title. If left as an empty string, there will be no title. + /// @param pic The icon to show at the top left. + /// @param t The type of icon to show. + /// @param parent Optionally, a parent dialog. cStrDlog(std::string str1,std::string str2,std::string title,pic_num_t pic,ePicType t,cDialog* parent = NULL); + /// Set a sound to be played when the dialog is shown. + /// @param num The sound number. + /// @return This object, for method-call chaining. cStrDlog& setSound(snd_num_t num); + /// Set a record handler. + /// @param rec The handler. + /// @return This object, for method-call chaining. + /// @note Only one record handler can be set at a time. To remove it, set it to null. + /// @note The presence of the Record button is determined entirely by the presence of a record handler. + /// + /// A record handler should take one parameter, which is a reference to the dialog. + /// (That's the cDialog, not the cStrDlog.) It should return void. cStrDlog& setRecordHandler(record_callback_t rec); + /// Reference the cDialog powering this choice dialog, perhaps to customize details of it. + /// @return A pointer to the dialog. cDialog* operator->(); + /// Show the dialog. void show(); }; +/// A simple dialog that lets you select one of several buttons. +/// This class loads a definition from a file, so there can be any amount of other stuff in the dialog, +/// and the buttons could be arranged in any fashion you want. class cChoiceDlog { cDialog dlg; protected: + /// The click handler for the dialog's buttons. + /// @param me A reference to the current dialog. + /// @param id The unique key of the clicked control. + /// @return true, indicating the event should continue. bool onClick(cDialog& me, std::string id); + /// Create a choice dialog, but don't initialize it. + /// @param p Optionally, a parent dialog. explicit cChoiceDlog(cDialog* p = NULL); public: + /// Create a choice dialog with just one button. + /// @param file The file to load the dialog definition from. + /// @param p Optionally, a parent dialog. + /// @note The dialog definition file must include a button whose name attribute is "okay". explicit cChoiceDlog(std::string file, cDialog* p = NULL); + /// Create a choice dialog with several buttons. + /// @param file The file to load the dialog definition from. + /// @param buttons A list of the buttons to handle. All of them must be defined in the file. + /// @param p Optionally, a parent dialog. cChoiceDlog(std::string file, std::vector buttons, cDialog* p = NULL); + /// Reference the cDialog powering this choice dialog, perhaps to customize details of it. + /// @return A pointer to the dialog. cDialog* operator->(); + /// Show the dialog. + /// @return The unique key of the clicked button. std::string show(); }; -struct bbtt { // stands for "basic button type template" - eBtnType type; - std::string label; - cKey defaultKey; +/// Basic button type template +struct bbtt { + eBtnType type; ///< The type of the preset button. + std::string label; ///< The preset button's label, if any. + cKey defaultKey; ///< The preset button's default key shortcut, if any. }; +/// Represents a preset button for use with cThreeChoice. typedef boost::optional cBasicButtonType; namespace {cBasicButtonType null_btn = boost::none;} @@ -65,6 +113,10 @@ extern bbtt basic_buttons[]; extern size_t available_btns[53]; #endif +/// A choice dialog with several strings and up to three buttons. +/// This is the class used for dialogs generated by special nodes. +/// It generates the dialog dynamically from the given input. +/// Note that the dialog is not limited to six strings. class cThreeChoice : public cChoiceDlog { //static std::string getFileName(size_t n_strs); cBasicButtonType btns[3]; @@ -74,12 +126,34 @@ class cThreeChoice : public cChoiceDlog { void init_pict(pic_num_t pic); const ePicType type; public: + /// Create a dialog with just one button. + /// @param strings A list of the strings to place in the dialog. + /// @param button The specification of the button. + /// @param pic The icon to show at the top left. + /// @param t The type of the icon. + /// @param parent Optionally, a parent dialog. cThreeChoice(std::vector& strings, cBasicButtonType button, pic_num_t pic, ePicType t, cDialog* parent = NULL); + /// Create a dialog with up to three buttons. + /// @param strings A list of the strings to place in the dialog. + /// @param buttons A list of the button specifications. + /// @param pic The icon to show at the top left. + /// @param t The type of the icon. + /// @param parent Optionally, a parent dialog. cThreeChoice(std::vector& strings, std::array& buttons, pic_num_t pic, ePicType t, cDialog* parent = NULL); + /// Create a dialog with up to three buttons. + /// @param strings A list of the strings to place in the dialog. + /// @param buttons A list of the index of the button; this is an index into available_btns which is in turn used to index basic_buttons. + /// @param pic The icon to show at the top left. + /// @param t The type of the icon. + /// @param parent Optionally, a parent dialog. cThreeChoice(std::vector& strings, std::array& buttons, pic_num_t pic, ePicType t, cDialog* parent = NULL); + /// @copydoc cChoiceDlog::show() + /// @note The unique key in this case is the label specified in the button specification. std::string show(); }; +/// A dialog that presents a list of strings with LEDs and allows you to choose one. +/// The list may span several pages. class cStringChoice { static const size_t per_page; cDialog dlg; @@ -94,12 +168,29 @@ class cStringChoice { size_t page, cur; cLedGroup* leds; public: + /// Initializes a dialog from a list of strings. + /// @param strs A list of all strings in the dialog. + /// @param title The title to show in the dialog. + /// @param parent Optionally, a parent dialog. explicit cStringChoice(std::vector& strs, std::string title, cDialog* parent = NULL); + /// Initializes a dialog from an iterator pair. + /// @param begin An iterator to the first string in the dialog. + /// @param end An iterator to one past the last string in the dialog. + /// @param title The title to show in the dialog. + /// @param parent Optionally, a parent dialog. + /// @note Currently, only vector iterators are supported. cStringChoice(std::vector::iterator begin, std::vector::iterator end, std::string title, cDialog* parent = NULL); + /// Reference the cDialog powering this choice dialog, perhaps to customize details of it. + /// @return A pointer to the dialog. cDialog* operator->(); + /// Show the dialog. + /// @param selectedIndex The index of the string that should be initially selected when the dialog is shown. + /// @return The index of the newly selected string; if the user cancelled, this will be equal to selectedIndex. + /// If initialized from an iterator range, this will be relative to begin. size_t show(size_t selectedIndex); }; +/// Like cStringChoice, but presents a list of icons rather than strings. class cPictChoice { static const size_t per_page; bool didAccept; @@ -115,17 +206,51 @@ class cPictChoice { size_t page, cur; cLedGroup* leds; public: + /// Initializes a dialog from a list of icons. + /// @param pics A list of all icons in the dialog. + /// @param t The type of icons to show; all icons are assumed to be of the same type. + /// @param parent Optionally, a parent dialog. cPictChoice(std::vector& pics, ePicType t, cDialog* parent = NULL); + /// Initializes a dialog from a list of icons. + /// @param pics A list of all icons in the dialog as {num,type} pairs. + /// @param parent Optionally, a parent dialog. cPictChoice(std::vector>& pics, cDialog* parent = NULL); + /// Initializes a dialog from an iterator pair. + /// @param begin An iterator to the first icon in the dialog. + /// @param end An iterator to one past the last icon in the dialog. + /// @param t The type of icons to show; all icons are assumed to be of the same type. + /// @param parent Optionally, a parent dialog. cPictChoice(std::vector::iterator begin, std::vector::iterator end, ePicType t, cDialog* parent = NULL); + /// Initializes a dialog from an index pair. + /// @param first The number of the first icon in the dialog. + /// @param last The number of the last icon in the dialog. + /// @param t The type of icons to show; all icons are assumed to be of the same type. + /// @param parent Optionally, a parent dialog. cPictChoice(pic_num_t first, pic_num_t last, ePicType t, cDialog* parent = NULL); + /// Reference the cDialog powering this choice dialog, perhaps to customize details of it. + /// @return A pointer to the dialog. cDialog* operator->(); + /// Show the dialog. + /// @param cur_sel The index of the icon that should be initially selected when the dialog is shown. + /// @return false if the user clicked Cancel, true otherwise. + /// @note If for some reason an icon appears twice in the list, there's no way to determine which of the two was selected. bool show(size_t cur_sel); + /// Get the chosen icon. + /// @return The number of the chosen icon. pic_num_t getPicChosen(); + /// Get the chosen icon. + /// @return The type of the chosen icon. ePicType getPicChosenType(); - // returns the _number_ of the chosen picture, _not_ the index; there's no way to distinguish between duplicates }; #endif +/// Shows a simple error dialog. +/// @param str1 The first string in the error dialog. +/// @param str2 The second string in the error dialog. +/// @param parent Optionally, a parent dialog. void giveError(std::string str1, std::string str2 = "", cDialog* parent = NULL); +/// Shows a generic error dialog and exits. +/// @param error An arbitrary code intended to be used for locating the error in the source. +/// @param code A code indicating the result of a failed action that triggered the error. +/// @param mode 0 for scenario editor, 1 for game, 2 for pc editor void oopsError(short error,short code = 0, short mode = 0); diff --git a/osx/dialogxml/field.h b/osx/dialogxml/field.h index 4ce340cd..53801b59 100644 --- a/osx/dialogxml/field.h +++ b/osx/dialogxml/field.h @@ -9,36 +9,59 @@ #ifndef FIELD_H #define FIELD_H +/// @file +/// Field-related classes and types. + #include #include "control.h" +/// The field's expected input type. enum eFldType { - FLD_INT, - FLD_UINT, - FLD_REAL, - FLD_TEXT, + FLD_INT, ///< A field that accepts only integers. + FLD_UINT, ///< A field that accepts only positive integers. + FLD_REAL, ///< A field that accepts any real (floating-point) number. + FLD_TEXT, ///< A field that accepts any text. This is the default. }; +/// An editable text field. +/// The text field supports multiline input and text selection. +/// It automatically scrolls to keep the insertion point in view. +/// (If there's a current selection, the mobile end of the selection is kept in view.) +/// Mouse support is currently nonexistent, except for focusing when clicked. +/// There is no Unicode support. class cTextField : public cControl { public: void attachClickHandler(click_callback_t f) throw(xHandlerNotSupported); + /// @copydoc cControl::attachFocusHandler() + /// For text fields, this is triggered when it loses or gains the input focus. void attachFocusHandler(focus_callback_t f) throw(); bool triggerFocusHandler(cDialog& me, std::string id, bool losingFocus); bool handleClick(location where); void setFormat(eFormat prop, short val) throw(xUnsupportedProp); short getFormat(eFormat prop) throw(xUnsupportedProp); void setColour(sf::Color clr) throw(xUnsupportedProp); + /// Get the current input type of the field. + /// @return The input type. eFldType getInputType(); + /// Set the input type of the field. + /// @param newType The new input type. void setInputType(eFldType newType); sf::Color getColour() throw(xUnsupportedProp); + /// Create a new editable text field. + /// @param parent The parent dialog. explicit cTextField(cDialog* parent); bool isClickable(); virtual ~cTextField(); void draw(); + /// Check if this text field currently has input focus. + /// @return true if it it is currently focused. bool hasFocus(); + /// Handle keyboard input. + /// @param key The keypress to handle. void handleInput(cKey key); cTextField& operator=(cTextField& other) = delete; cTextField(cTextField& other) = delete; + /// This field is only used by cDialog during the loading process. Changing it will have no effect. long tabOrder = 0; private: eFldType field_type; diff --git a/osx/dialogxml/message.h b/osx/dialogxml/message.h index 13eaee9d..66b73052 100644 --- a/osx/dialogxml/message.h +++ b/osx/dialogxml/message.h @@ -9,12 +9,17 @@ #ifndef MESSAGE_H #define MESSAGE_H +/// @file +/// Message-related classes and types. + #include #include #include "control.h" #include "graphtool.h" // for eFont +/// A simple static text message. +/// This class can also create a frame for grouping controls or a clickable area. class cTextMsg : public cControl { public: void attachClickHandler(click_callback_t f) throw(); @@ -24,7 +29,11 @@ public: short getFormat(eFormat prop) throw(xUnsupportedProp); void setColour(sf::Color clr) throw(xUnsupportedProp); sf::Color getColour() throw(xUnsupportedProp); + /// Create a new text message. + /// @param parent The parent dialog. explicit cTextMsg(cDialog& parent); + /// Create a new text message without a parent dialog. + /// @param parent The parent window. explicit cTextMsg(sf::RenderWindow& parent); bool isClickable(); virtual ~cTextMsg(); diff --git a/osx/dialogxml/pict.h b/osx/dialogxml/pict.h index 2569a8fa..e172a240 100644 --- a/osx/dialogxml/pict.h +++ b/osx/dialogxml/pict.h @@ -9,6 +9,9 @@ #ifndef PICT_H #define PICT_H +/// @file +/// Icon-related classes and types. + #include #include @@ -16,86 +19,94 @@ #include "graphtool.h" // for pic_num_t #include "control.h" +/// Specifies an icon type. enum ePicType { - PIC_TER = 1, // 28x36 terrain graphic from the preset sheets - PIC_TER_ANIM = 2, // 28x36 terrain graphic from the preset animated terrain sheet - PIC_MONST = 3, // 28x36 monster graphic from the preset sheets - PIC_DLOG = 4, // 36x36 dialog graphic from the preset sheet - PIC_TALK = 5, // 32x32 talking portrait from the preset sheet - PIC_SCEN = 6, // 32x32 scenario graphic from the scenario sheet - PIC_ITEM = 7, // 28x36 item graphic from the large item sheet, or 18x18 item graphic from the small sheet centred in a 28x36 space - PIC_PC = 8, // 28x36 pc graphic from the player sheet - PIC_FIELD = 9, // 28x36 field graphic from the fields sheet - PIC_BOOM = 10, // 28x36 boom graphic from the booms sheet - PIC_FULL = 11, // entire sheet graphic; number is the resource ID - PIC_MISSILE = 12, // 18x18 missile graphic from the missiles sheet - PIC_DLOG_LG = 13, // 72x72 dialog graphic from the dialog sheet - PIC_SCEN_LG = 14, // 64x64 scenario graphic (currently each is on its own sheet) - PIC_TER_MAP = 15, // 12x12 map graphic... or should it be 6x6? - PIC_STATUS = 16, // 12x12 status icon - PIC_MONST_WIDE = 23, // 56x36 monster graphic from the preset sheets, resized to fit and centred in a 28x36 space - PIC_MONST_TALL = 43, // 28x72 monster graphic from the preset sheets, resized to fit and centred in a 28x36 space - PIC_MONST_LG = 63, // 56x72 monster graphic from the preset sheets, resized to fit in a 28x36 space - PIC_CUSTOM_TER = 101, // 28x36 custom graphic from the custom sheets - PIC_CUSTOM_TER_ANIM = 102, - PIC_CUSTOM_MONST = 103, - PIC_CUSTOM_DLOG = 104, // 36x36 dialog graphic drawn from two 18x26 halves in the custom sheets - PIC_CUSTOM_TALK = 105, // 32x32 talking portrait drawn from two 16x32 halves in the custom sheets - PIC_CUSTOM_SCEN = 106, // 32x32 scenario portrait loading from scenname.exr/scenario.png - PIC_CUSTOM_ITEM = 107, - PIC_CUSTOM_FULL = 111, // entire sheet graphic, drawn from scenname.exr/sheetxxx.png where xxx is the number - PIC_CUSTOM_MISSILE = 112, // 18x18 missile graphic drawn from the the custom sheets - PIC_CUSTOM_DLOG_LG = 113, // 72x72 dialog graphic from the custom sheet, taken from 8 successive slots - PIC_CUSTOM_TER_MAP = 115, // 12x12 map graphic (should it be 6x6?) taken from the custom sheet - PIC_CUSTOM_MONST_WIDE = 123, // 56x36 monster graphic from the custom sheets, resized to fit and centred in a 28x36 space - PIC_CUSTOM_MONST_TALL = 143, // 28x72 monster graphic from the custom sheets, resized to fit and centred in a 28x36 space - PIC_CUSTOM_MONST_LG = 163, // 56x72 monster graphic from the custom sheets, resized to fit in a 28x36 space - PIC_PARTY_MONST = 203, // 28x36 graphic drawn from the savegame sheet - PIC_PARTY_SCEN = 206, // 32x32 graphic drawn from the scenario headers sheet - PIC_PARTY_ITEM = 207, - PIC_PARTY_PC = 208, - PIC_PARTY_MONST_WIDE = 223, // 56x36 monster graphic from the savegame sheet, resized to fit and centred in a 28x36 space - PIC_PARTY_MONST_TALL = 243, // 28x72 monster graphic from the savegame sheet, resized to fit and centred in a 28x36 space - PIC_PARTY_MONST_LG = 263, // 56x72 monster graphic from the savegame sheet, resized to fit in a 28x36 space + PIC_TER = 1, ///< 28x36 terrain graphic from the preset sheets + PIC_TER_ANIM = 2, ///< 28x36 terrain graphic from the preset animated terrain sheet + PIC_MONST = 3, ///< 28x36 monster graphic from the preset sheets + PIC_DLOG = 4, ///< 36x36 dialog graphic from the preset sheet + PIC_TALK = 5, ///< 32x32 talking portrait from the preset sheet + PIC_SCEN = 6, ///< 32x32 scenario graphic from the scenario sheet + PIC_ITEM = 7, ///< 28x36 item graphic from the large item sheet, + ///< or 18x18 item graphic from the small sheet centred in a 28x36 space + PIC_PC = 8, ///< 28x36 pc graphic from the player sheet + PIC_FIELD = 9, ///< 28x36 field graphic from the fields sheet + PIC_BOOM = 10, ///< 28x36 boom graphic from the booms sheet + PIC_FULL = 11, ///< entire sheet graphic; number is the resource ID + PIC_MISSILE = 12, ///< 18x18 missile graphic from the missiles sheet + PIC_DLOG_LG = 13, ///< 72x72 dialog graphic from the dialog sheet + PIC_SCEN_LG = 14, ///< 64x64 scenario graphic (currently each is on its own sheet) + PIC_TER_MAP = 15, ///< 12x12 map graphic... or should it be 6x6? + PIC_STATUS = 16, ///< 12x12 status icon + PIC_MONST_WIDE = 23, ///< 56x36 monster graphic from the preset sheets, resized to fit and centred in a 28x36 space + PIC_MONST_TALL = 43, ///< 28x72 monster graphic from the preset sheets, resized to fit and centred in a 28x36 space + PIC_MONST_LG = 63, ///< 56x72 monster graphic from the preset sheets, resized to fit in a 28x36 space + PIC_CUSTOM_TER = 101, ///< 28x36 custom terrain graphic from the custom sheets + PIC_CUSTOM_TER_ANIM = 102, ///< 28x36 custom animated terrain graphic from the custom sheets + PIC_CUSTOM_MONST = 103, ///< 28x36 custom monster graphic from the custom sheets + PIC_CUSTOM_DLOG = 104, ///< 36x36 dialog graphic drawn from two 18x26 halves in the custom sheets + PIC_CUSTOM_TALK = 105, ///< 32x32 talking portrait drawn from two 16x32 halves in the custom sheets + PIC_CUSTOM_SCEN = 106, ///< 32x32 scenario portrait loading from scenname.exr/scenario.png + PIC_CUSTOM_ITEM = 107, ///< 28x36 custom item graphic from the custom sheets + PIC_CUSTOM_FULL = 111, ///< entire sheet graphic, drawn from scenname.exr/sheetxxx.png where xxx is the number + PIC_CUSTOM_MISSILE = 112, ///< 18x18 missile graphic drawn from the the custom sheets + PIC_CUSTOM_DLOG_LG = 113, ///< 72x72 dialog graphic from the custom sheet, taken from 8 successive slots + PIC_CUSTOM_TER_MAP = 115, ///< 12x12 map graphic (should it be 6x6?) taken from the custom sheet + PIC_CUSTOM_MONST_WIDE = 123,///< 56x36 monster graphic from the custom sheets, resized to fit and centred in a 28x36 space + PIC_CUSTOM_MONST_TALL = 143,///< 28x72 monster graphic from the custom sheets, resized to fit and centred in a 28x36 space + PIC_CUSTOM_MONST_LG = 163, ///< 56x72 monster graphic from the custom sheets, resized to fit in a 28x36 space + PIC_PARTY_MONST = 203, ///< 28x36 monster graphic drawn from the savegame sheet + PIC_PARTY_SCEN = 206, ///< 32x32 graphic drawn from the scenario headers sheet + PIC_PARTY_ITEM = 207, ///< 28x36 item graphic drawn from the savegame sheet + PIC_PARTY_PC = 208, ///< 28x36 PC graphic drawn from the savegame sheet + PIC_PARTY_MONST_WIDE = 223, ///< 56x36 monster graphic from the savegame sheet, resized to fit and centred in a 28x36 space + PIC_PARTY_MONST_TALL = 243, ///< 28x72 monster graphic from the savegame sheet, resized to fit and centred in a 28x36 space + PIC_PARTY_MONST_LG = 263, ///< 56x72 monster graphic from the savegame sheet, resized to fit in a 28x36 space NUM_PIC_TYPES }; +/// Flags that modify icon types. +/// Can be added to or subtracted from ePicType enums, returning an ePicType. enum ePicTypeMod { - // Can be added to or subtracted from ePicType enums, returning an ePicType. - PIC_PRESET = 0, // just for good measure - PIC_WIDE = 20, // if applied to any derivative of PIC_MONST, makes the x-dimension 2 instead of 1 - PIC_TALL = 40, // if applied to any derivative of PIC_MONST, makes the y-dimension 2 instead of 1 - PIC_LARGE = PIC_WIDE + PIC_TALL, - PIC_CUSTOM = 100, // if applied to any customizable graphic, makes it custom instead of preset - PIC_PARTY = 200, // similar to above + PIC_PRESET = 0, ///< No mod, included just for good measure; can be added to cancel out all mods. + PIC_WIDE = 20, ///< If applied to any derivative of PIC_MONST, makes the x-dimension 2 instead of 1. + PIC_TALL = 40, ///< If applied to any derivative of PIC_MONST, makes the y-dimension 2 instead of 1. + PIC_LARGE = PIC_WIDE + PIC_TALL, ///< A combination of PIC_WIDE and PIC_TALL. + PIC_CUSTOM = 100, ///< If applied to any customizable graphic, makes it custom instead of preset. + PIC_PARTY = 200, ///< If applies to any exportable graphic, makes it exported instead of preset. }; +/// Specifies a graphics sheet that icons are drawn from. enum eSheetType { - SHEET_TER, - SHEET_TER_ANIM, - SHEET_MONST, - SHEET_DLOG, - SHEET_TALK, - SHEET_SCEN, - SHEET_SCEN_LG, - SHEET_ITEM, - SHEET_TINY_ITEM, - SHEET_PC, - SHEET_FIELD, - SHEET_BOOM, - SHEET_MISSILE, - SHEET_PARTY, - SHEET_HEADER, - SHEET_TER_MAP, - SHEET_FULL, - SHEET_STATUS, - SHEET_CUSTOM, + SHEET_TER, ///< The preset terrain sheets, terX.png + SHEET_TER_ANIM, ///< The animated terrains sheet, teranim.png + SHEET_MONST, ///< The preset monster sheets, monstX.png + SHEET_DLOG, ///< The preset dialog icons sheet, dlogpics.png + SHEET_TALK, ///< The preset talk icons sheet, talkportraits.png + SHEET_SCEN, ///< The preset scenario icons sheet, scenpics.png + SHEET_SCEN_LG, ///< The large scenario icons sheet, bigscenpics.png + SHEET_ITEM, ///< The preset large items sheet, objects.png + SHEET_TINY_ITEM,///< The small itesm sheet, tinyobj.png + SHEET_PC, ///< The PC graphics sheet, pcs.png + SHEET_FIELD, ///< The fields and objects sheet, fields.png + SHEET_BOOM, ///< The special effects sheet, booms.png + SHEET_MISSILE, ///< The missile animations sheet, missles.png + SHEET_PARTY, ///< The exported graphics sheet stored in the saved game + SHEET_HEADER, ///< The scenario header sheet + SHEET_TER_MAP, ///< The terrain map icons sheet, termap.png + SHEET_FULL, ///< Any full sheet + SHEET_STATUS, ///< The status icons sheet, staticons.png + SHEET_CUSTOM, ///< Any custom graphics sheet // TODO: Vehicle sheet is missing. + // TODO: Documentation of full, custom, header, and exported sheets is still lacking. NUM_SHEET_TYPES }; +/// A simple icon. +/// This control can also be made clickable. class cPict : public cControl { public: + /// @copydoc cDialog::init() static void init(); void attachClickHandler(click_callback_t f) throw(); void attachFocusHandler(focus_callback_t f) throw(xHandlerNotSupported); @@ -104,16 +115,40 @@ public: short getFormat(eFormat prop) throw(xUnsupportedProp); void setColour(sf::Color clr) throw(xUnsupportedProp); sf::Color getColour() throw(xUnsupportedProp); + /// @copydoc setPict(pic_num_t) + /// @param type The type of the new icon + /// @note If you change to a type with a different bounding rect, + /// you will need to separately update the bounding rect. + /// (The bounding rect is mostly ignored when drawing, so if the icon is opaque, the control is not clickable, + /// and there is no frame, you can usually safely skip this step.) void setPict(pic_num_t num, ePicType type); + /// Set the pict's icon. + /// @param num The new icon index. void setPict(pic_num_t num); + /// Get the current icon. + /// @return The number of the current icon. pic_num_t getPicNum(); + /// Get the current icon's type. + /// @return The type of the current icon. ePicType getPicType(); + /// Create a new icon. + /// @param parent The parent dialog. explicit cPict(cDialog& parent); + /// Create a new icon without a parent dialog. + /// @param parent The parent window. explicit cPict(sf::RenderWindow& parent); bool isClickable(); + /// Advance the current animation frame. + /// Should be called at predictable intervals if the dialog might contain an animated graphic. static void advanceAnim(); virtual ~cPict(); void draw(); + /// A utility function to draw an icon into an arbitrary window. + /// @param win The window to draw in. + /// @param dest The bounding rect to draw in (ignored for drawing the actual, but used for background fill and framing) + /// @param which_g The icon to draw. + /// @param type_g The type of icon to draw. + /// @param framed Whether to draw a frame around the icon. static void drawAt(sf::RenderWindow& win, RECT dest, pic_num_t which_g, ePicType type_g, bool framed); cPict& operator=(cPict& other) = delete; cPict(cPict& other) = delete; @@ -165,12 +200,43 @@ private: click_callback_t onClick; }; +/// Apply a modifier to an icon type. +/// @param lhs The base icon type to modify. +/// @param rhs The modifier to apply. +/// @return The modified icon type. +/// @note As a special case, adding PIC_PRESET removes all modifiers. ePicType operator + (ePicType lhs, ePicTypeMod rhs); +/// Remove a modifier from an icon type. +/// @param lhs The base icon type to modify. +/// @param rhs The modifier to remove. +/// @return The modified icon type. ePicType operator - (ePicType lhs, ePicTypeMod rhs); +/// Apply a modifier to an icon type. +/// @param lhs The modifier to apply. +/// @param rhs The base icon type to modify. +/// @return The modified icon type. +/// @note As a special case, adding PIC_PRESET removes all modifiers. ePicType operator + (ePicTypeMod lhs, ePicType rhs); +/// Remove a modifier from an icon type. +/// @param lhs The modifier to remove. +/// @param rhs The base icon type to modify. +/// @return The modified icon type. ePicType operator - (ePicTypeMod lhs, ePicType rhs); +/// Apply a modifier to an icon type. +/// @param lhs The base icon type to modify. +/// @param rhs The modifier to apply. +/// @return lhs, now modified. +/// @note As a special case, adding PIC_PRESET removes all modifiers. ePicType&operator +=(ePicType&lhs, ePicTypeMod rhs); +/// Remove a modifier from an icon type. +/// @param lhs The base icon type to modify. +/// @param rhs The modifier to remove. +/// @return lhs, now modified. ePicType&operator -=(ePicType&lhs, ePicTypeMod rhs); +/// Check if an icon type has a modifier applied. +/// @param lhs The icon type to check. +/// @param rhs The modifier type to test for. +/// @return true if the modifier is present. bool operator& (ePicType lhs, ePicTypeMod rhs); #endif diff --git a/osx/dialogxml/scrollbar.h b/osx/dialogxml/scrollbar.h index ab9c6a21..aa8809ce 100644 --- a/osx/dialogxml/scrollbar.h +++ b/osx/dialogxml/scrollbar.h @@ -9,8 +9,14 @@ #ifndef BoE_scrollbar_h #define BoE_scrollbar_h +/// @file +/// Scrollbar-related classes and types. + #include "control.h" +/// A simple vertical scrollbar. +/// This has no coupling with scrollable data; that must be handled externally by +/// using the methods to get the scrollbar's position. class cScrollbar : public cControl { int pos, max, pgsz; enum { @@ -23,8 +29,13 @@ class cScrollbar : public cControl { click_callback_t onClick; static sf::Texture scroll_gw; public: + /// @copydoc cDialog::init() static void init(); + /// Create a new scrollbar without a parent dialog. + /// @param parent The parent window. explicit cScrollbar(sf::RenderWindow& parent); + /// Create a new scrollbar. + /// @param parent The parent dialog. explicit cScrollbar(cDialog& parent); void attachClickHandler(click_callback_t f) throw(xHandlerNotSupported); void attachFocusHandler(focus_callback_t f) throw(xHandlerNotSupported); @@ -35,11 +46,29 @@ public: void setColour(sf::Color clr) throw(xUnsupportedProp); sf::Color getColour() throw(xUnsupportedProp); bool isClickable(); + /// Get the scrollbar thumb's current position. + /// @return The current position. long getPosition(); + /// Get the scrollbar thumb's maximum value. + /// @return The maximum value. long getMaximum(); + /// Get the scrollbar thumb's page size. + /// @return The page size. + /// + /// The page size is the number of steps scrolled when a click is received + /// in the area between the arrow buttons and the scrollbar thumb. long getPageSize(); + /// Set the scrollbar thumb's current position. + /// @param to The current position. void setPosition(long to); + /// Set the scrollbar thumb's maximum value. + /// @param to The maximum value. void setMaximum(long to); + /// Set the scrollbar thumb's page size. + /// @param to The page size. + /// + /// The page size is the number of steps scrolled when a click is received + /// in the area between the arrow buttons and the scrollbar thumb. void setPageSize(long to); void draw(); cScrollbar& operator=(cScrollbar& other) = delete; diff --git a/osx/doxy/.gitignore b/osx/doxy/.gitignore new file mode 100644 index 00000000..5ccff1a6 --- /dev/null +++ b/osx/doxy/.gitignore @@ -0,0 +1 @@ +html/ diff --git a/osx/doxy/Doxyfile b/osx/doxy/Doxyfile new file mode 100644 index 00000000..cdb5261f --- /dev/null +++ b/osx/doxy/Doxyfile @@ -0,0 +1,2325 @@ +# Doxyfile 1.8.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Blades of Exile" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = YES + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = doxy_warnings.txt + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = ../dialogxml \ + mainpage.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = YES + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /