diff options
Diffstat (limited to 'src/gui')
| -rw-r--r-- | src/gui/color.h | 8 | ||||
| -rw-r--r-- | src/gui/focushandler.h | 2 | ||||
| -rw-r--r-- | src/gui/gui.h | 19 | ||||
| -rw-r--r-- | src/gui/models/shopitems.h | 2 | ||||
| -rw-r--r-- | src/gui/rect.h | 26 | ||||
| -rw-r--r-- | src/gui/userpalette.h | 12 | ||||
| -rw-r--r-- | src/gui/viewport.h | 2 | ||||
| -rw-r--r-- | src/gui/widgets/basiccontainer.h | 3 | ||||
| -rw-r--r-- | src/gui/widgets/dropdown.h | 8 | ||||
| -rw-r--r-- | src/gui/widgets/itemcontainer.h | 8 | ||||
| -rw-r--r-- | src/gui/widgets/label.h | 2 | ||||
| -rw-r--r-- | src/gui/widgets/listbox.h | 4 | ||||
| -rw-r--r-- | src/gui/widgets/scrollarea.h | 5 | ||||
| -rw-r--r-- | src/gui/widgets/tabs/chat/chattab.h | 3 | ||||
| -rw-r--r-- | src/gui/widgets/widget.h | 98 |
15 files changed, 19 insertions, 183 deletions
diff --git a/src/gui/color.h b/src/gui/color.h index 247427e3d..2fc8573c6 100644 --- a/src/gui/color.h +++ b/src/gui/color.h @@ -107,10 +107,10 @@ class Color final /** * Constructor. The default alpha value is 255. * - * @param r Red color component (range 0-255). - * @param g Green color component (range 0-255). - * @param b Blue color component (range 0-255). - * @param a Alpha, used for transparency. A value of 0 means + * @param ar Red color component (range 0-255). + * @param ag Green color component (range 0-255). + * @param ab Blue color component (range 0-255). + * @param aa Alpha, used for transparency. A value of 0 means * totaly transparent, 255 is totaly opaque. */ constexpr Color(const unsigned int ar, diff --git a/src/gui/focushandler.h b/src/gui/focushandler.h index 2885cad28..3d0847515 100644 --- a/src/gui/focushandler.h +++ b/src/gui/focushandler.h @@ -331,7 +331,6 @@ class FocusHandler final * Distributes a focus lost event. * * @param focusEvent the event to distribute. - * @since 0.7.0 */ static void distributeFocusLostEvent(const Event& focusEvent); @@ -339,7 +338,6 @@ class FocusHandler final * Distributes a focus gained event. * * @param focusEvent the event to distribute. - * @since 0.7.0 */ static void distributeFocusGainedEvent(const Event& focusEvent); diff --git a/src/gui/gui.h b/src/gui/gui.h index 960c19bf9..a846f1a5d 100644 --- a/src/gui/gui.h +++ b/src/gui/gui.h @@ -235,7 +235,6 @@ class Gui final * * @param top The top widget. * @see Container - * @since 0.1.0 */ void setTop(Widget *const top); @@ -244,7 +243,6 @@ class Gui final * of the GUI. * * @return The top widget. NULL if no top widget has been set. - * @since 0.1.0 */ Widget* getTop() const noexcept2 A_WARN_UNUSED { return mTop; } @@ -255,7 +253,6 @@ class Gui final * @param graphics The graphics object to use for drawing. * @see getGraphics, AllegroGraphics, HGEGraphics, * OpenLayerGraphics, OpenGLGraphics, SDLGraphics - * @since 0.1.0 */ void setGraphics(Graphics *const graphics) A_NONNULL(2); @@ -266,7 +263,6 @@ class Gui final * graphics object has been set. * @see setGraphics, AllegroGraphics, HGEGraphics, * OpenLayerGraphics, OpenGLGraphics, SDLGraphics - * @since 0.1.0 */ Graphics* getGraphics() const RETURNS_NONNULL A_WARN_UNUSED; @@ -276,7 +272,6 @@ class Gui final * @param input The input object to use for input handling. * @see getInput, AllegroInput, HGEInput, OpenLayerInput, * SDLInput - * @since 0.1.0 */ void setInput(SDLInput *const input) A_NONNULL(2); @@ -287,7 +282,6 @@ class Gui final * input object has been set. * @see setInput, AllegroInput, HGEInput, OpenLayerInput, * SDLInput - * @since 0.1.0 */ SDLInput* getInput() const A_WARN_UNUSED; @@ -299,7 +293,6 @@ class Gui final * * @param keyListener The key listener to add. * @see removeGlobalKeyListener - * @since 0.5.0 */ void addGlobalKeyListener(KeyListener *const keyListener); @@ -309,7 +302,6 @@ class Gui final * @param keyListener The key listener to remove. * @throws Exception if the key listener hasn't been added. * @see addGlobalKeyListener - * @since 0.5.0 */ void removeGlobalKeyListener(KeyListener *const keyListener); @@ -339,7 +331,6 @@ class Gui final * Handles mouse wheel moved down input. * * @param mouseInput The mouse input to handle. - * @since 0.6.0 */ void handleMouseWheelMovedDown(const MouseInput& mouseInput); @@ -347,7 +338,6 @@ class Gui final * Handles mouse wheel moved up input. * * @param mouseInput The mouse input to handle. - * @since 0.6.0 */ void handleMouseWheelMovedUp(const MouseInput& mouseInput); @@ -355,7 +345,6 @@ class Gui final * Gets the widget at a certain position. * * @return The widget at a certain position. - * @since 0.6.0 */ Widget* getWidgetAt(const int x, const int y) const A_WARN_UNUSED; @@ -363,7 +352,6 @@ class Gui final * Gets the source of the mouse event. * * @return The source widget of the mouse event. - * @since 0.6.0 */ Widget* getMouseEventSource(const int x, const int y) const A_WARN_UNUSED; @@ -372,7 +360,6 @@ class Gui final * Gets the source of the key event. * * @return The source widget of the key event. - * @since 0.6.0 */ Widget* getKeyEventSource() const A_WARN_UNUSED; @@ -381,7 +368,6 @@ class Gui final * * @param event The key event to distribute. - * @since 0.6.0 */ void distributeKeyEvent(KeyEvent &event) const; @@ -390,7 +376,6 @@ class Gui final * * @param event The key event to distribute. * - * @since 0.6.0 */ void distributeKeyEventToGlobalKeyListeners(KeyEvent& event); @@ -399,7 +384,6 @@ class Gui final * to be checked at each logic iteration as it might be necessary to * distribute mouse entered or mouse exited events. * - * @since 0.8.0 */ void handleModalMouseInputFocus(); @@ -408,7 +392,6 @@ class Gui final * each logic iteration as it might be necessary to distribute * mouse entered or mouse exited events. * - * @since 0.8.0 */ void handleModalFocus(); @@ -416,7 +399,6 @@ class Gui final * Handles modal focus gained. If modal focus has been gained it might * be necessary to distribute mouse entered or mouse exited events. * - * @since 0.8.0 */ void handleModalFocusGained(); @@ -425,7 +407,6 @@ class Gui final * gained it might be necessary to distribute mouse entered or mouse * exited events. * - * @since 0.8.0 */ void handleModalFocusReleased(); diff --git a/src/gui/models/shopitems.h b/src/gui/models/shopitems.h index eee4ae588..42594a7c6 100644 --- a/src/gui/models/shopitems.h +++ b/src/gui/models/shopitems.h @@ -74,7 +74,7 @@ class ShopItems final : public ListModel * * @param inventoryIndex the inventory index of the item * @param id the id of the item - * @param quantity number of available copies of the item + * @param amount number of available copies of the item * @param price price of the item */ ShopItem *addItem2(const int inventoryIndex, diff --git a/src/gui/rect.h b/src/gui/rect.h index 75f6fffc6..994886e92 100644 --- a/src/gui/rect.h +++ b/src/gui/rect.h @@ -68,8 +68,6 @@ /** * Represents a rectangle. - * - * @since 0.1.0 */ class Rect notfinal { @@ -89,11 +87,10 @@ class Rect notfinal /** * Constructor. * - * @param x The x coordinate of the rectangle. - * @param y The y coordinate of the rectangle. - * @param width The width of the rectangle. - * @param height The height of the rectangle. - * @since 0.1.0 + * @param x_ The x coordinate of the rectangle. + * @param y_ The y coordinate of the rectangle. + * @param width_ The width of the rectangle. + * @param height_ The height of the rectangle. */ constexpr Rect(const int x_, const int y_, @@ -129,11 +126,10 @@ class Rect notfinal /** * Sets the dimension of a rectangle. * - * @param x The x coordinate of the rectangle. - * @param y The y coordinate of the rectangle. - * @param width The width of the rectangle. - * @param height The height of the rectangle. - * @since 0.1.0 + * @param x0 The x coordinate of the rectangle. + * @param y0 The y coordinate of the rectangle. + * @param width0 The width of the rectangle. + * @param height0 The height of the rectangle. */ void setAll(const int x0, const int y0, @@ -151,7 +147,6 @@ class Rect notfinal * * @param rectangle Another rectangle to check for intersection. * @return True if the rectangles intersect, false otherwise. - * @since 0.1.0 */ bool isIntersecting(const Rect& rectangle) const A_WARN_UNUSED { @@ -192,10 +187,9 @@ class Rect notfinal /** * Checks if a point is inside the rectangle * - * @param x The x coordinate of the point. - * @param y The y coordinate of the point. + * @param x_ The x coordinate of the point. + * @param y_ The y coordinate of the point. * @return True if the point is inside the rectangle. - * @since 0.1.0 */ bool isPointInRect(const int x_, const int y_) const A_WARN_UNUSED diff --git a/src/gui/userpalette.h b/src/gui/userpalette.h index 9e268449c..4f7e0e941 100644 --- a/src/gui/userpalette.h +++ b/src/gui/userpalette.h @@ -105,11 +105,6 @@ class UserPalette final : public Palette, public ListModel void setGradient(const UserColorIdT type, const GradientTypeT grad); - /** - * Sets the gradient delay for the specified color. - * - * @param grad gradient type to set - */ void setGradientDelay(const UserColorIdT type, const int delay) { mColors[CAST_SIZE(type)].delay = delay; } @@ -240,13 +235,6 @@ class UserPalette final : public Palette, public ListModel static std::string getConfigName(const std::string &typeName) A_WARN_UNUSED; - /** - * Initialise color - * - * @param c character that needs initialising - * @param rgb default color if not found in config - * @param text identifier of color - */ void addColor(const UserColorIdT type, const unsigned rgb, GradientTypeT grad, diff --git a/src/gui/viewport.h b/src/gui/viewport.h index f7360c42a..aa2c09832 100644 --- a/src/gui/viewport.h +++ b/src/gui/viewport.h @@ -134,7 +134,7 @@ class Viewport final : public WindowContainer, { mPixelViewX += x; mPixelViewY += y; } /** - * Clear all hover item\being etc + * Clear all hover item, being etc */ void cleanHoverItems(); diff --git a/src/gui/widgets/basiccontainer.h b/src/gui/widgets/basiccontainer.h index 73bd641ba..ba2681bdc 100644 --- a/src/gui/widgets/basiccontainer.h +++ b/src/gui/widgets/basiccontainer.h @@ -74,7 +74,6 @@ * container, consider inheriting from this class. * * @see Container - * @since 0.6.0 */ class BasicContainer notfinal : public Widget, public WidgetDeathListener @@ -103,7 +102,7 @@ class BasicContainer notfinal : public Widget, * * @param widget The widget whom wants a specific part of * itself to be visible. - * @param rectangle The rectangle to be visible. + * @param area The rectangle to be visible. */ void showWidgetPart(Widget *restrict const widget, const Rect &restrict area) restrict2 override; diff --git a/src/gui/widgets/dropdown.h b/src/gui/widgets/dropdown.h index dd9109475..029850766 100644 --- a/src/gui/widgets/dropdown.h +++ b/src/gui/widgets/dropdown.h @@ -55,14 +55,6 @@ class DropDown final : public ActionListener, public SelectionListener { public: - /** - * Contructor. - * - * @param listModel the ListModel to use. - * @param scrollArea the ScrollArea to use. - * @param listBox the listBox to use. - * @see ListModel, ScrollArea, ListBox. - */ DropDown(const Widget2 *const widget, ListModel *const listModel, const bool extended = false, diff --git a/src/gui/widgets/itemcontainer.h b/src/gui/widgets/itemcontainer.h index 333de842c..2d732ad3c 100644 --- a/src/gui/widgets/itemcontainer.h +++ b/src/gui/widgets/itemcontainer.h @@ -51,14 +51,6 @@ class ItemContainer final : public Widget, public WidgetListener { public: - /** - * Constructor. Initializes the graphic. - * - * @param inventory - * @param gridColumns Amount of columns in grid. - * @param gridRows Amount of rows in grid. - * @param offset Index offset - */ ItemContainer(const Widget2 *const widget, Inventory *const inventory, const int maxColumns = 100000, diff --git a/src/gui/widgets/label.h b/src/gui/widgets/label.h index 6b598bdda..26790258c 100644 --- a/src/gui/widgets/label.h +++ b/src/gui/widgets/label.h @@ -146,7 +146,7 @@ class Label final : public Widget, * Sets the alignment of the caption. The alignment is relative * to the center of the label. * - * @param alignemnt The alignment of the caption of the label. + * @param alignment The alignment of the caption of the label. * @see getAlignment, Graphics */ void setAlignment(Graphics::Alignment alignment) diff --git a/src/gui/widgets/listbox.h b/src/gui/widgets/listbox.h index 5efe7cce3..5c90058a8 100644 --- a/src/gui/widgets/listbox.h +++ b/src/gui/widgets/listbox.h @@ -231,7 +231,6 @@ class ListBox notfinal : public Widget, * using removeSelectionListener(). * * @param selectionListener The selection listener to add. - * @since 0.8.0 */ void addSelectionListener(SelectionListener *const selectionListener); @@ -239,7 +238,6 @@ class ListBox notfinal : public Widget, * Removes a selection listener from the list box. * * @param selectionListener The selection listener to remove. - * @since 0.8.0 */ void removeSelectionListener(SelectionListener *const selectionListener); @@ -247,8 +245,6 @@ class ListBox notfinal : public Widget, /** * Distributes a value changed event to all selection listeners * of the list box. - * - * @since 0.8.0 */ void distributeValueChangedEvent(); diff --git a/src/gui/widgets/scrollarea.h b/src/gui/widgets/scrollarea.h index 573fa9cc5..50b194d28 100644 --- a/src/gui/widgets/scrollarea.h +++ b/src/gui/widgets/scrollarea.h @@ -108,11 +108,6 @@ class ScrollArea final : public BasicContainer, SHOW_AUTO }; - /** - * Constructor. - * - * @param content the initial content to show in the scroll area - */ ScrollArea(Widget2 *const widget2, Widget *const widget, const Opaque opaque = Opaque_true, diff --git a/src/gui/widgets/tabs/chat/chattab.h b/src/gui/widgets/tabs/chat/chattab.h index de0969f94..e3bdf1c1e 100644 --- a/src/gui/widgets/tabs/chat/chattab.h +++ b/src/gui/widgets/tabs/chat/chattab.h @@ -74,9 +74,8 @@ class ChatTab notfinal : public Tab * * @param line Text message. * @param own Type of message (usually the owner-type). - * @param channelName which channel to send the message to. * @param ignoreRecord should this not be recorded? - * @param removeColors try remove color if configured + * @param tryRemoveColors try remove color if configured */ void chatLog(std::string line, ChatMsgTypeT own, diff --git a/src/gui/widgets/widget.h b/src/gui/widgets/widget.h index 262b9bb52..4a9957738 100644 --- a/src/gui/widgets/widget.h +++ b/src/gui/widgets/widget.h @@ -93,7 +93,6 @@ class WidgetListener; * * @author Olof Naessén * @author Per Larsson. - * @since 0.1.0 */ class Widget notfinal : public Widget2 { @@ -122,7 +121,6 @@ class Widget notfinal : public Widget2 * outside of a widget's dimension. * * @param graphics aA graphics object to draw with. - * @since 0.1.0 */ virtual void draw(Graphics *const graphics) A_NONNULL(2) = 0; @@ -146,7 +144,6 @@ class Widget notfinal : public Widget2 * * @param graphics A graphics object to draw with. * @see setFrameSize, getFrameSize - * @since 0.8.0 */ virtual void drawFrame(Graphics* graphics A_UNUSED) A_NONNULL(2) { } @@ -166,7 +163,6 @@ class Widget notfinal : public Widget2 * * @param frameSize The size of the widget's frame. * @see getFrameSize, drawFrame - * @since 0.8.0 */ void setFrameSize(const unsigned int frameSize) noexcept2 { mFrameSize = frameSize; } @@ -183,7 +179,6 @@ class Widget notfinal : public Widget2 * * @return The size of the widget's frame. * @see setFrameSize, drawFrame - * @since 0.8.0 */ unsigned int getFrameSize() const noexcept2 A_WARN_UNUSED { return mFrameSize; } @@ -193,7 +188,6 @@ class Widget notfinal : public Widget2 * You can do logic stuff here like playing an animation. * * @see Gui::logic - * @since 0.1.0 */ virtual void logic() { } @@ -203,7 +197,6 @@ class Widget notfinal : public Widget2 * * @return The widget's parent container. NULL if the widget * has no parent. - * @since 0.1.0 */ Widget* getParent() const noexcept2 A_WARN_UNUSED { return mParent; } @@ -214,7 +207,6 @@ class Widget notfinal : public Widget2 * @param width The width of the widget. * @see getWidth, setHeight, getHeight, setSize, * setDimension, getDimensi - * @since 0.1.0 */ void setWidth(const int width); @@ -224,7 +216,6 @@ class Widget notfinal : public Widget2 * @return The width of the widget. * @see setWidth, setHeight, getHeight, setSize, * setDimension, getDimension - * @since 0.1.0 */ int getWidth() const noexcept2 A_WARN_UNUSED { return mDimension.width; } @@ -235,7 +226,6 @@ class Widget notfinal : public Widget2 * @param height The height of the widget. * @see getHeight, setWidth, getWidth, setSize, * setDimension, getDimension - * @since 0.1.0 */ void setHeight(const int height); @@ -245,7 +235,6 @@ class Widget notfinal : public Widget2 * @return The height of the widget. * @see setHeight, setWidth, getWidth, setSize, * setDimension, getDimension - * @since 0.1.0 */ int getHeight() const noexcept2 A_WARN_UNUSED { return mDimension.height; } @@ -257,7 +246,6 @@ class Widget notfinal : public Widget2 * @param height The height of the widget. * @see setWidth, setHeight, getWidth, getHeight, * setDimension, getDimension - * @since 0.1.0 */ void setSize(const int width, const int height); @@ -267,7 +255,6 @@ class Widget notfinal : public Widget2 * * @param x The x coordinate of the widget. * @see getX, setY, getY, setPosition, setDimension, getDimension - * @since 0.1.0 */ void setX(const int x); @@ -277,7 +264,6 @@ class Widget notfinal : public Widget2 * * @return The x coordinate of the widget. * @see setX, setY, getY, setPosition, setDimension, getDimension - * @since 0.1.0 */ int getX() const noexcept2 A_WARN_UNUSED { return mDimension.x; } @@ -288,7 +274,6 @@ class Widget notfinal : public Widget2 * * @param y The y coordinate of the widget. * @see setY, setX, getX, setPosition, setDimension, getDimension - * @since 0.1.0 */ void setY(const int y); @@ -298,7 +283,6 @@ class Widget notfinal : public Widget2 * * @return The y coordinate of the widget. * @see setY, setX, getX, setPosition, setDimension, getDimension - * @since 0.1.0 */ int getY() const noexcept2 A_WARN_UNUSED { return mDimension.y; } @@ -310,7 +294,6 @@ class Widget notfinal : public Widget2 * @param x The x coordinate of the widget. * @param y The y coordinate of the widget. * @see setX, getX, setY, getY, setDimension, getDimension - * @since 0.1.0 */ void setPosition(const int x, const int y); @@ -320,7 +303,6 @@ class Widget notfinal : public Widget2 * * @param dimension The dimension of the widget. * @see getDimension, setX, getX, setY, getY, setPosition - * @since 0.1.0 */ void setDimension(const Rect& dimension); @@ -330,7 +312,6 @@ class Widget notfinal : public Widget2 * * @return The dimension of the widget. * @see getDimension, setX, getX, setY, getY, setPosition - * @since 0.1.0 */ const Rect& getDimension() const noexcept2 A_WARN_UNUSED { return mDimension; } @@ -341,7 +322,6 @@ class Widget notfinal : public Widget2 * @param focusable True if the widget should be focusable, * false otherwise. * @see isFocusable - * @since 0.1.0 */ void setFocusable(const bool focusable); @@ -350,7 +330,6 @@ class Widget notfinal : public Widget2 * * @return True if the widget should be focusable, false otherwise. * @see setFocusable - * @since 0.1.0 */ bool isFocusable() const A_WARN_UNUSED; @@ -358,7 +337,6 @@ class Widget notfinal : public Widget2 * Checks if the widget is focused. * * @return True if the widget is focused, false otherwise. - * @since 0.1.0 */ virtual bool isFocused() const A_WARN_UNUSED; @@ -369,7 +347,6 @@ class Widget notfinal : public Widget2 * @param enabled True if widget should be enabled, * false otherwise. * @see isEnabled - * @since 0.1.0 */ void setEnabled(const bool enabled) noexcept2 { mEnabled = enabled; } @@ -380,7 +357,6 @@ class Widget notfinal : public Widget2 * * @return True if widget is enabled, false otherwise. * @see setEnabled - * @since 0.1.0 */ bool isEnabled() const A_WARN_UNUSED; @@ -389,7 +365,6 @@ class Widget notfinal : public Widget2 * * @param visible True if widget should be visible, false otherwise. * @see isVisible - * @since 0.1.0 */ void setVisible(Visible visible); @@ -398,7 +373,6 @@ class Widget notfinal : public Widget2 * * @return True if widget is be visible, false otherwise. * @see setVisible - * @since 0.1.0 */ bool isVisible() const A_WARN_UNUSED { return mVisible == Visible_true && @@ -409,7 +383,6 @@ class Widget notfinal : public Widget2 * * @param color The baseground color. * @see getBaseColor - * @since 0.1.0 */ void setBaseColor(const Color& color) noexcept2 { mBaseColor = color; } @@ -419,7 +392,6 @@ class Widget notfinal : public Widget2 * * @return The base color. * @see setBaseColor - * @since 0.1.0 */ const Color& getBaseColor() const noexcept2 A_WARN_UNUSED { return mBaseColor; } @@ -429,7 +401,6 @@ class Widget notfinal : public Widget2 * * @param color The foreground color. * @see getForegroundColor - * @since 0.1.0 */ void setForegroundColor(const Color& color) noexcept2 { mForegroundColor = color; } @@ -438,7 +409,6 @@ class Widget notfinal : public Widget2 * Gets the foreground color. * * @see setForegroundColor - * @since 0.1.0 */ const Color& getForegroundColor() const noexcept2 A_WARN_UNUSED { return mForegroundColor; } @@ -448,7 +418,6 @@ class Widget notfinal : public Widget2 * * @param color The background Color. * @see setBackgroundColor - * @since 0.1.0 */ void setBackgroundColor(const Color &color) noexcept2 { mBackgroundColor = color; } @@ -457,7 +426,6 @@ class Widget notfinal : public Widget2 * Gets the background color. * * @see setBackgroundColor - * @since 0.1.0 */ const Color &getBackgroundColor() const noexcept2 A_WARN_UNUSED { return mBackgroundColor; } @@ -487,7 +455,6 @@ class Widget notfinal : public Widget2 * * @param focusHandler The focus handler to use. * @see getFocusHandler - * @since 0.1.0 */ virtual void setFocusHandler(FocusHandler *const focusHandler); @@ -500,7 +467,6 @@ class Widget notfinal : public Widget2 * * @return The focus handler used. * @see setFocusHandler - * @since 0.1.0 */ FocusHandler* getFocusHandler() noexcept2 A_WARN_UNUSED { return mFocusHandler; } @@ -512,7 +478,6 @@ class Widget notfinal : public Widget2 * * @param actionListener The action listener to add. * @see removeActionListener - * @since 0.1.0 */ void addActionListener(ActionListener *const actionListener); @@ -521,7 +486,6 @@ class Widget notfinal : public Widget2 * * @param actionListener The action listener to remove. * @see addActionListener - * @since 0.1.0 */ void removeActionListener(ActionListener *const actionListener); @@ -532,7 +496,6 @@ class Widget notfinal : public Widget2 * * @param deathListener The death listener to add. * @see removeDeathListener - * @since 0.1.0 */ void addDeathListener(WidgetDeathListener *const deathListener); @@ -541,7 +504,6 @@ class Widget notfinal : public Widget2 * * @param deathListener The death listener to remove. * @see addDeathListener - * @since 0.1.0 */ void removeDeathListener(WidgetDeathListener *const deathListener); @@ -552,7 +514,6 @@ class Widget notfinal : public Widget2 * * @param mouseListener The mouse listener to add. * @see removeMouseListener - * @since 0.1.0 */ void addMouseListener(MouseListener *const mouseListener); @@ -561,7 +522,6 @@ class Widget notfinal : public Widget2 * * @param mouseListener The mouse listener to remove. * @see addMouseListener - * @since 0.1.0 */ void removeMouseListener(MouseListener *const mouseListener); @@ -572,7 +532,6 @@ class Widget notfinal : public Widget2 * * @param keyListener The key listener to add. * @see removeKeyListener - * @since 0.1.0 */ void addKeyListener(KeyListener *const keyListener); @@ -581,7 +540,6 @@ class Widget notfinal : public Widget2 * * @param keyListener The key listener to remove. * @see addKeyListener - * @since 0.1.0 */ void removeKeyListener(KeyListener *const keyListener); @@ -592,7 +550,6 @@ class Widget notfinal : public Widget2 * * @param focusListener The focus listener to add. * @see removeFocusListener - * @since 0.7.0 */ void addFocusListener(FocusListener *const focusListener); @@ -601,7 +558,6 @@ class Widget notfinal : public Widget2 * * @param focusListener The focus listener to remove. * @see addFocusListener - * @since 0.7.0 */ void removeFocusListener(FocusListener *const focusListener); @@ -612,7 +568,6 @@ class Widget notfinal : public Widget2 * * @param widgetListener The widget listener to add. * @see removeWidgetListener - * @since 0.8.0 */ void addWidgetListener(WidgetListener *const widgetListener); @@ -621,7 +576,6 @@ class Widget notfinal : public Widget2 * * @param widgetListener The widget listener to remove. * @see addWidgetListener - * @since 0.8.0 */ void removeWidgetListener(WidgetListener *const widgetListener); @@ -635,7 +589,6 @@ class Widget notfinal : public Widget2 * * @param actionEventId The action event identifier. * @see getActionEventId - * @since 0.6.0 */ void setActionEventId(const std::string &actionEventId) noexcept2 { mActionEventId = actionEventId; } @@ -645,7 +598,6 @@ class Widget notfinal : public Widget2 * * @return The action event identifier of the widget. * @see setActionEventId - * @since 0.6.0 */ const std::string &getActionEventId() const noexcept2 { return mActionEventId; } @@ -655,7 +607,6 @@ class Widget notfinal : public Widget2 * * @param x The absolute x coordinate will be stored in this parameter. * @param y The absolute y coordinate will be stored in this parameter. - * @since 0.1.0 */ virtual void getAbsolutePosition(int& x, int& y) const; @@ -668,7 +619,6 @@ class Widget notfinal : public Widget2 * * @param parent The parent of the widget. * @see getParent - * @since 0.1.0 */ virtual void setParent(Widget* parent) { mParent = parent; } @@ -680,7 +630,6 @@ class Widget notfinal : public Widget2 * * @return The font set for the widget. * @see setFont, setGlobalFont - * @since 0.1.0 */ Font *getFont() const RETURNS_NONNULL A_WARN_UNUSED; @@ -689,7 +638,6 @@ class Widget notfinal : public Widget2 * * @param font The global font. * @see getGlobalFont - * @since 0.1.0 */ static void setGlobalFont(Font *const font); @@ -699,7 +647,6 @@ class Widget notfinal : public Widget2 * * @param font The font to set for the widget. * @see getFont - * @since 0.1.0 */ void setFont(Font *const font); @@ -707,8 +654,6 @@ class Widget notfinal : public Widget2 * Called when the font has changed. If the change is global, * this function will only be called if the widget doesn't have a * font already set. - * - * @since 0.1.0 */ virtual void fontChanged() { } @@ -719,7 +664,6 @@ class Widget notfinal : public Widget2 * * @param widget The widget to check. * @return True if an instance of the widget exists, false otherwise. - * @since 0.1.0 */ static bool widgetExists(const Widget *const widget) A_WARN_UNUSED; @@ -731,7 +675,6 @@ class Widget notfinal : public Widget2 * * @return True if tab in is enabled, false otherwise. * @see setTabInEnabled - * @since 0.1.0 */ bool isTabInEnabled() const noexcept2 A_WARN_UNUSED { return mTabIn; } @@ -744,7 +687,6 @@ class Widget notfinal : public Widget2 * * @param enabled True if tab in should be enabled, false otherwise. * @see isTabInEnabled - * @since 0.1.0 */ void setTabInEnabled(const bool enabled) noexcept2 { mTabIn = enabled; } @@ -757,7 +699,6 @@ class Widget notfinal : public Widget2 * * @return True if tab out is enabled, false otherwise. * @see setTabOutEnabled - * @since 0.1.0 */ bool isTabOutEnabled() const noexcept2 A_WARN_UNUSED { return mTabOut; } @@ -770,7 +711,6 @@ class Widget notfinal : public Widget2 * * @param enabled True if tab out should be enabled, false otherwise. * @see isTabOutEnabled - * @since 0.1.0 */ void setTabOutEnabled(const bool enabled) noexcept2 { mTabOut = enabled; } @@ -781,7 +721,6 @@ class Widget notfinal : public Widget2 * * @throws Exception if another widget already has modal focus. * @see releaseModalFocus, isModalFocused - * @since 0.4.0 */ virtual void requestModalFocus(); @@ -792,7 +731,6 @@ class Widget notfinal : public Widget2 * * @throws Exception if another widget already has modal focus. * @see releaseModalMouseInputFocus, isModalMouseInputFocused - * @since 0.6.0 */ virtual void requestModalMouseInputFocus(); @@ -801,7 +739,6 @@ class Widget notfinal : public Widget2 * widget has modal focus. * * @see requestModalFocus, isModalFocused - * @since 0.4.0 */ virtual void releaseModalFocus(); @@ -810,7 +747,6 @@ class Widget notfinal : public Widget2 * be released if the widget has modal mouse input focus. * * @see requestModalMouseInputFocus, isModalMouseInputFocused - * @since 0.6.0 */ virtual void releaseModalMouseInputFocus(); @@ -819,7 +755,6 @@ class Widget notfinal : public Widget2 * * @return True if the widget has modal focus, false otherwise. * @see requestModalFocus, releaseModalFocus - * @since 0.8.0 */ virtual bool isModalFocused() const A_WARN_UNUSED; @@ -829,7 +764,6 @@ class Widget notfinal : public Widget2 * @return True if the widget has modal mouse input focus, false * otherwise. * @see requestModalMouseInputFocus, releaseModalMouseInputFocus - * @since 0.8.0 */ virtual bool isModalMouseInputFocused() const A_WARN_UNUSED; @@ -845,7 +779,6 @@ class Widget notfinal : public Widget2 * @param y The y coordinate of the widget to get. * @return The widget at the specified coodinate, NULL * if no widget is found. - * @since 0.6.0 */ virtual Widget *getWidgetAt(int x A_UNUSED, int y A_UNUSED) A_WARN_UNUSED @@ -855,7 +788,6 @@ class Widget notfinal : public Widget2 * Gets the mouse listeners of the widget. * * @return The mouse listeners of the widget. - * @since 0.6.0 */ const std::list<MouseListener*>& getMouseListeners() const A_CONST A_WARN_UNUSED; @@ -864,7 +796,6 @@ class Widget notfinal : public Widget2 * Gets the key listeners of the widget. * * @return The key listeners of the widget. - * @since 0.6.0 */ const std::list<KeyListener*>& getKeyListeners() const A_CONST A_WARN_UNUSED; @@ -873,7 +804,6 @@ class Widget notfinal : public Widget2 * Gets the focus listeners of the widget. * * @return The focus listeners of the widget. - * @since 0.7.0 */ const std::list<FocusListener*>& getFocusListeners() const A_CONST A_WARN_UNUSED; @@ -896,7 +826,6 @@ class Widget notfinal : public Widget2 * @see BasicContainer * @see BasicContainer::getChildrenArea * @see BasicContainer::drawChildren - * @since 0.1.0 */ virtual Rect getChildrenArea() A_WARN_UNUSED; @@ -906,7 +835,6 @@ class Widget notfinal : public Widget2 * @return the internalFocusHandler used. If no internal focus handler * is used, NULL will be returned. * @see setInternalFocusHandler - * @since 0.1.0 */ virtual FocusHandler* getInternalFocusHandler() A_WARN_UNUSED; @@ -917,7 +845,6 @@ class Widget notfinal : public Widget2 * * @param focusHandler The internal focus handler to be used. * @see getInternalFocusHandler - * @since 0.1.0 */ void setInternalFocusHandler(FocusHandler *const internalFocusHandler); @@ -927,7 +854,6 @@ class Widget notfinal : public Widget2 * * @param widget The widget to move to the top. * @see moveToBottom - * @since 0.1.0 */ virtual void moveToTop(Widget* widget A_UNUSED) { } @@ -938,7 +864,6 @@ class Widget notfinal : public Widget2 * * @param widget The widget to move to the bottom. * @see moveToTop - * @since 0.1.0 */ virtual void moveToBottom(Widget* widget A_UNUSED) { } @@ -947,7 +872,6 @@ class Widget notfinal : public Widget2 * Focuses the next widget in the widget. * * @see moveToBottom - * @since 0.1.0 */ virtual void focusNext() { } @@ -956,7 +880,6 @@ class Widget notfinal : public Widget2 * Focuses the previous widget in the widget. * * @see moveToBottom - * @since 0.1.0 */ virtual void focusPrevious() { } @@ -967,7 +890,6 @@ class Widget notfinal : public Widget2 * * @param widget The target widget. * @param area The area to show. - * @since 0.1.0 */ virtual void showWidgetPart(Widget *const widget A_UNUSED, const Rect &area A_UNUSED) @@ -981,21 +903,10 @@ class Widget notfinal : public Widget2 * * @param id The id to set to the widget. * @see getId - * @since 0.8.0 */ void setId(const std::string& id) { mId = id; } - /** - * Gets the id of a widget. An id can be useful if a widget needs to be - * identified in a container. For example, if widgets are created by an - * XML document, a certain widget can be retrieved given that the widget - * has an id. - * - * @param id The id to set to the widget. - * @see setId - * @since 0.8.0 - */ const std::string& getId() const noexcept2 A_WARN_UNUSED { return mId; } @@ -1007,7 +918,6 @@ class Widget notfinal : public Widget2 * of a ScrollArea. * * @param rectangle The rectangle to be shown. - * @since 0.8.0 */ virtual void showPart(const Rect &rectangle); @@ -1047,29 +957,22 @@ class Widget notfinal : public Widget2 /** * Distributes an action event to all action listeners * of the widget. - * - * @since 0.8.0 */ void distributeActionEvent(); /** * Distributes resized events to all of the widget's listeners. - * - * @since 0.8.0 */ void distributeResizedEvent(); /** * Distributes moved events to all of the widget's listeners. - * - * @since 0.8.0 */ void distributeMovedEvent(); /** * Distributes hidden events to all of the widget's listeners. * - * @since 0.8.0 * @author Olof Naessén */ void distributeHiddenEvent(); @@ -1077,7 +980,6 @@ class Widget notfinal : public Widget2 /** * Distributes shown events to all of the widget's listeners. * - * @since 0.8.0 * @author Olof Naessén */ void distributeShownEvent(); |