[Wgui-cvs] wgui/includes wg_button.h,1.26,1.27 wg_checkbox.h,1.14,1.15 wg_dropdown.h,1.13,1.14 wg_ed
Status: Beta
Brought to you by:
greenwire
Menu
▾
▴
[Wgui-cvs] wgui/includes wg_button.h,1.26,1.27 wg_checkbox.h,1.14,1.15 wg_dropdown.h,1.13,1.14 wg_editbox.h,1.54,1.55 wg_error.h,1.12,1.13 wg_frame.h,1.15,1.16 wg_groupbox.h,1.12,1.13 wg_label.h,1.17,1.18 wg_listbox.h,1.24,1.25 wg_menu.h,1.32,1.33 wg_message.h,1.29,1.30 wg_message_server.h,1.22,1.23 wg_point.h,1.16,1.17 wg_progress.h,1.17,1.18 wg_range_control.h,1.3,1.4 wg_rect.h,1.29,1.30 wg_resource_handle.h,1.17,1.18 wg_scrollbar.h,1.23,1.24 wg_textbox.h,1.11,1.12 wg_timer.h,1.16,1.17 wg_toolbar.h,1.13,1.14 wg_view.h,1.23,1.24 wg_window.h,1.35,1.36
Update of /cvsroot/wgui/wgui/includes In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14331/includes Modified Files: wg_button.h wg_checkbox.h wg_dropdown.h wg_editbox.h wg_error.h wg_frame.h wg_groupbox.h wg_label.h wg_listbox.h wg_menu.h wg_message.h wg_message_server.h wg_point.h wg_progress.h wg_range_control.h wg_rect.h wg_resource_handle.h wg_scrollbar.h wg_textbox.h wg_timer.h wg_toolbar.h wg_view.h wg_window.h Log Message: Documentation fixes. Index: wg_textbox.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_textbox.h,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** wg_textbox.h 13 Apr 2004 19:15:26 -0000 1.11 --- wg_textbox.h 3 Jun 2004 19:10:52 -0000 1.12 *************** *** 59,65 **** --- 59,67 ---- virtual void SetReadOnly(bool bReadOnly); + //! Indicates if the text box is in read-only mode //! \return true if the control is read-only virtual bool IsReadOnly(void) const { return m_bReadOnly; } + //! Gets the currently selected text //! \return The currently selected text in the edit box, if the edit box is in Password Mask mode, this will always return an empty string virtual std::string GetSelText(void) const; *************** *** 70,76 **** virtual void SetSelection(std::string::size_type iSelStart, int iSelLength); ! //! \return The start of the selection virtual std::string::size_type GetSelectionStart(void) const { return m_SelStart; } //! \return The length of the selection virtual int GetSelectionLength(void) const { return m_SelLength; } --- 72,80 ---- virtual void SetSelection(std::string::size_type iSelStart, int iSelLength); ! //! Gets the start of the selection ! //! \return The index of the start of the selection virtual std::string::size_type GetSelectionStart(void) const { return m_SelStart; } + //! Gets the selection length //! \return The length of the selection virtual int GetSelectionLength(void) const { return m_SelLength; } *************** *** 94,98 **** virtual EScrollBarVisibility GetScrollBarVisibility(CScrollBar::EScrollBarType ScrollBarType) const { return m_ScrollBarVisibilityMap.find(ScrollBarType)->second; } ! // CWindow overrides --- 98,102 ---- virtual EScrollBarVisibility GetScrollBarVisibility(CScrollBar::EScrollBarType ScrollBarType) const { return m_ScrollBarVisibilityMap.find(ScrollBarType)->second; } ! // CWindow overrides *************** *** 164,168 **** unsigned int m_iRowHeight; //!< The row height unsigned int m_iMaxWidth; //!< The width of the longest line (in pixels) ! private: --- 168,172 ---- unsigned int m_iRowHeight; //!< The row height unsigned int m_iMaxWidth; //!< The width of the longest line (in pixels) ! private: Index: wg_groupbox.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_groupbox.h,v retrieving revision 1.12 retrieving revision 1.13 diff -C2 -d -r1.12 -r1.13 *** wg_groupbox.h 2 Apr 2004 17:26:14 -0000 1.12 --- wg_groupbox.h 3 Jun 2004 19:10:52 -0000 1.13 *************** *** 59,62 **** --- 59,63 ---- void SetFontColor(CRGBColor& FontColor) { m_FontColor = FontColor; } + //! Gets the font color for the label od the group box //! \return The color of the text in the label CRGBColor GetFontColor(void) { return m_FontColor; } Index: wg_frame.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_frame.h,v retrieving revision 1.15 retrieving revision 1.16 diff -C2 -d -r1.15 -r1.16 *** wg_frame.h 2 Apr 2004 17:26:13 -0000 1.15 --- wg_frame.h 3 Jun 2004 19:10:52 -0000 1.16 *************** *** 67,70 **** --- 67,71 ---- void SetTitleBarHeight(int iTitleBarHeight); + //! Indicates if the frame is resizable (set in the object constructor) //! \return true if the frame is resizable bool IsResizable(void) { return m_bResizable; } *************** *** 74,77 **** --- 75,79 ---- void AttachMenu(CMenu* pMenu); + //! Gets the menu for a frame //! \return A pointer to the frame's menu, 0 if the view doesn't have a menu CMenu* GetMenu(void) { return m_pMenu; } Index: wg_checkbox.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_checkbox.h,v retrieving revision 1.14 retrieving revision 1.15 diff -C2 -d -r1.14 -r1.15 *** wg_checkbox.h 2 Apr 2004 17:26:13 -0000 1.14 --- wg_checkbox.h 3 Jun 2004 19:10:52 -0000 1.15 *************** *** 57,60 **** --- 57,61 ---- }; + //! Gets the current state of the checkbox //! \return The current checkbox state EState GetCheckBoxState(void) const { return m_eCheckBoxState; } Index: wg_listbox.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_listbox.h,v retrieving revision 1.24 retrieving revision 1.25 diff -C2 -d -r1.24 -r1.25 *** wg_listbox.h 2 Apr 2004 17:26:14 -0000 1.24 --- wg_listbox.h 3 Jun 2004 19:10:52 -0000 1.25 *************** *** 71,77 **** --- 71,79 ---- virtual ~CListBox(void); + //! Gets the height of the items //! \return The height of the items in the listbox unsigned int GetItemHeight(void) { return m_iItemHeight; } + //! Sets the heigh of the items in the listbox //! \param iItemHeight The height of the items in the listbox void SetItemHeight(unsigned int iItemHeight); *************** *** 94,97 **** --- 96,100 ---- void ClearItems(void); + //! Gets the number of items in the listbox //! \return The number of items in the list int Size(void) { return stdex::safe_static_cast<int>(m_Items.size()); } Index: wg_window.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_window.h,v retrieving revision 1.35 retrieving revision 1.36 diff -C2 -d -r1.35 -r1.36 *** wg_window.h 20 Apr 2004 18:59:06 -0000 1.35 --- wg_window.h 3 Jun 2004 19:10:52 -0000 1.36 *************** *** 68,71 **** --- 68,72 ---- virtual void SetWindowRect(const CRect& WindowRect); + //! Gets the window's rectangle //! \return A copy of the CRect that the window represents virtual CRect GetWindowRect(void) const { return m_WindowRect; } *************** *** 100,103 **** --- 101,105 ---- virtual CWindow* GetAncestor(EAncestor eAncestor) const; + //! Gets the view the window is a part of //! \return A pointer to the view object for the window (if one exists), this assumes that the view is the root ancestor virtual CView* GetView(void) const; *************** *** 116,119 **** --- 118,122 ---- virtual void SetVisible(bool bVisible); + //! Gets the SDL surface the window draws to //! \return A pointer to the window's SDL surface virtual SDL_Surface* GetSDLSurface(void) { return m_pSDLSurface; } Index: wg_timer.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_timer.h,v retrieving revision 1.16 retrieving revision 1.17 diff -C2 -d -r1.16 -r1.17 *** wg_timer.h 2 Apr 2004 17:26:14 -0000 1.16 --- wg_timer.h 3 Jun 2004 19:10:52 -0000 1.17 *************** *** 59,65 **** --- 59,67 ---- void StopTimer(void); + //! Indicates if the timer is currently running //! \return true is the timer is currently running bool IsRunning(void) { return m_TimerID != 0; } + //! Gets the number of times the timer has triggered since it was last reset //! \return The count of times the timer has fired long int GetCount(void) const { return m_iCounter; } *************** *** 68,71 **** --- 70,74 ---- void ResetCount(void) { m_iCounter = 0; } + //! Gets the owner of the timer //! \return A pointer to the owner of the timer CMessageClient* GetOwner(void) { return m_pOwner; } Index: wg_progress.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_progress.h,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** wg_progress.h 4 May 2004 16:11:13 -0000 1.17 --- wg_progress.h 3 Jun 2004 19:10:52 -0000 1.18 *************** *** 47,50 **** --- 47,51 ---- virtual ~CProgress(void); + //! Gets the color of the bar //! \return The bar color CRGBColor GetBarColor(void) { return m_BarColor; } Index: wg_message.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_message.h,v retrieving revision 1.29 retrieving revision 1.30 diff -C2 -d -r1.29 -r1.30 *** wg_message.h 23 Apr 2004 19:38:47 -0000 1.29 --- wg_message.h 3 Jun 2004 19:10:52 -0000 1.30 *************** *** 83,92 **** --- 83,95 ---- virtual ~CMessage(void) { } + //! Gets the message type //! \return The message type of the message const EMessageType MessageType(void) { return m_MessageType; } + //! Gets the intended destination for the message //! \return A pointer to the destination of the message (0 for no specific destination, or to broadcast to all) const CMessageClient* Destination(void) { return m_pDestination; } + //! Gets the source of the message //! \return A pointer to the source of the message const CMessageClient* Source(void) { return m_pSource; } *************** *** 139,145 **** unsigned char ScanCode, SDLMod Modifiers, SDLKey Key, Uint16 Unicode); ! unsigned char ScanCode; //!< \param ScanCode The scan code of the key pressed ! SDLMod Modifiers; //!< \param Modifiers Any modifier keys that are being pressed (alt, ctrl, shift, etc) ! SDLKey Key; //!< \param Key The SDLKey that defines the key pressed Uint16 Unicode; //!< The unicode character the keypress corresponds to }; --- 142,148 ---- unsigned char ScanCode, SDLMod Modifiers, SDLKey Key, Uint16 Unicode); ! unsigned char ScanCode; //!< The scan code of the key pressed ! SDLMod Modifiers; //!< Any modifier keys that are being pressed (alt, ctrl, shift, etc) ! SDLKey Key; //!< The SDLKey that defines the key pressed Uint16 Unicode; //!< The unicode character the keypress corresponds to }; Index: wg_scrollbar.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_scrollbar.h,v retrieving revision 1.23 retrieving revision 1.24 diff -C2 -d -r1.23 -r1.24 *** wg_scrollbar.h 3 Jun 2004 18:40:52 -0000 1.23 --- wg_scrollbar.h 3 Jun 2004 19:10:52 -0000 1.24 *************** *** 59,62 **** --- 59,63 ---- virtual void SetJumpAmount(int iJumpAmount) { m_iJumpAmount = iJumpAmount; } + //! Get the amount that the scrollbar will jump by when the arrow buttons are clicked //! \return The amount the scrollbar jumps by when clicked above or below the thumb virtual int GetJumpAmount(void) const { return m_iJumpAmount; } Index: wg_range_control.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_range_control.h,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** wg_range_control.h 4 May 2004 16:11:13 -0000 1.3 --- wg_range_control.h 3 Jun 2004 19:10:52 -0000 1.4 *************** *** 54,58 **** virtual void SetMinLimit(T minLimit) { m_MinLimit = minLimit; } ! //! \return The minimum limit of the progress bar virtual T GetMinLimit(void) const { return m_MinLimit; } --- 54,59 ---- virtual void SetMinLimit(T minLimit) { m_MinLimit = minLimit; } ! //! Gets the lower limit of the control ! //! \return The minimum limit of the control virtual T GetMinLimit(void) const { return m_MinLimit; } *************** *** 61,71 **** virtual void SetMaxLimit(T maxLimit) { m_MaxLimit = maxLimit; } ! //! \return The maximum limit of the progress bar virtual T GetMaxLimit(void) const { return m_MaxLimit; } ! //! Set the current steo size. //! \param stepSize The amount to increment the value by for Increment() and Decrement() calls virtual void SetStepSize(T stepSize) { m_StepSize = stepSize; } //! \return The current step size virtual T GetStepSize(void) const { return m_StepSize; } --- 62,74 ---- virtual void SetMaxLimit(T maxLimit) { m_MaxLimit = maxLimit; } ! //! Gets teh upper limit of the control ! //! \return The maximum limit of the control virtual T GetMaxLimit(void) const { return m_MaxLimit; } ! //! Set the current step size. //! \param stepSize The amount to increment the value by for Increment() and Decrement() calls virtual void SetStepSize(T stepSize) { m_StepSize = stepSize; } + //! Gets the current step size of the control //! \return The current step size virtual T GetStepSize(void) const { return m_StepSize; } *************** *** 85,88 **** --- 88,92 ---- } + //! Gets the current value of the control //! \return The current value virtual T GetValue(void) const { return m_Value; } Index: wg_button.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_button.h,v retrieving revision 1.26 retrieving revision 1.27 diff -C2 -d -r1.26 -r1.27 *** wg_button.h 2 Apr 2004 17:26:13 -0000 1.26 --- wg_button.h 3 Jun 2004 19:10:52 -0000 1.27 *************** *** 61,64 **** --- 61,65 ---- }; + //! Gets the current state of the button //! \return The current button state EState GetButtonState(void) const { return m_eButtonState; } Index: wg_editbox.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_editbox.h,v retrieving revision 1.54 retrieving revision 1.55 diff -C2 -d -r1.54 -r1.55 *** wg_editbox.h 13 Apr 2004 19:15:26 -0000 1.54 --- wg_editbox.h 3 Jun 2004 19:10:52 -0000 1.55 *************** *** 58,61 **** --- 58,62 ---- void SetUsePasswordMask(bool bUseMask) { m_bUseMask = bUseMask; } + //! Indicates if the edit box is using a password mask //! \return true if the control is a password box bool UsingPasswordMask(void) const { return m_bUseMask; } *************** *** 65,71 **** --- 66,74 ---- void SetReadOnly(bool bReadOnly); + //! Indicates if the edit box is operating in read-only mode //! \return true if the control is read-only bool IsReadOnly(void) const { return m_bReadOnly; } + //! Gets the currently selected text //! \return The currently selected text in the edit box, if the edit box is in Password Mask mode, this will always return an empty string std::string GetSelText(void) const; *************** *** 76,82 **** void SetSelection(std::string::size_type iSelStart, int iSelLength); ! //! \return The start of the selection virtual std::string::size_type GetSelectionStart(void) const { return m_SelStart; } //! \return The length of the selection virtual int GetSelectionLength(void) const { return m_SelLength; } --- 79,87 ---- void SetSelection(std::string::size_type iSelStart, int iSelLength); ! //! Gets the starting index of the selection ! //! \return The index of the start of the selection virtual std::string::size_type GetSelectionStart(void) const { return m_SelStart; } + //! Gets the length of the selection //! \return The length of the selection virtual int GetSelectionLength(void) const { return m_SelLength; } Index: wg_view.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_view.h,v retrieving revision 1.23 retrieving revision 1.24 diff -C2 -d -r1.23 -r1.24 *** wg_view.h 13 Apr 2004 15:28:56 -0000 1.23 --- wg_view.h 3 Jun 2004 19:10:52 -0000 1.24 *************** *** 58,64 **** --- 58,66 ---- virtual ~CView(void); + //! Indicates if the view is resizable (set in the constructor) //! \return true if the view is resizable bool IsResizable(void) { return m_bResizable; } + //! Indicates id the view is fullscreen (set in the constructor) //! \return true if the view was created as fullscreen bool IsFullScreen(void) { return m_bFullScreen; } *************** *** 68,71 **** --- 70,74 ---- void AttachMenu(CMenu* pMenu); + //! Gets the menu for the view //! \return A pointer to the view's menu, 0 if the view doesn't have a menu CMenu* GetMenu(void) { return m_pMenu; } *************** *** 81,87 **** void SetFloatingWindow(CWindow* pWindow) { m_pFloatingWindow = pWindow; } //! \return a pointer to the current floating window CWindow* GetFloatingWindow(void) const { return m_pFloatingWindow; } ! // CWindow Overrides --- 84,91 ---- void SetFloatingWindow(CWindow* pWindow) { m_pFloatingWindow = pWindow; } + //! Gets teh current floating window //! \return a pointer to the current floating window CWindow* GetFloatingWindow(void) const { return m_pFloatingWindow; } ! // CWindow Overrides Index: wg_label.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_label.h,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** wg_label.h 2 Apr 2004 17:26:14 -0000 1.17 --- wg_label.h 3 Jun 2004 19:10:52 -0000 1.18 *************** *** 59,62 **** --- 59,63 ---- void SetFontColor(CRGBColor& FontColor) { m_FontColor = FontColor; } + //! Gets the font color for the label //! \return The color of the text in the label CRGBColor GetFontColor(void) { return m_FontColor; } Index: wg_message_server.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_message_server.h,v retrieving revision 1.22 retrieving revision 1.23 diff -C2 -d -r1.22 -r1.23 *** wg_message_server.h 2 Apr 2004 17:26:14 -0000 1.22 --- wg_message_server.h 3 Jun 2004 19:10:52 -0000 1.23 *************** *** 77,80 **** --- 77,81 ---- }; + //! Gets the single instance of the message server //! \return The single valid instance of the message server, or create one if it doesn't already exist static CMessageServer& Instance(void); *************** *** 102,108 **** --- 103,111 ---- void QueueMessage(CMessage* pMessage); + //! Indicates if there are any messages available //! \return true if there's a message available in the queue bool MessageAvailable(void) { return m_MessageQueue.size() > 0; } + //! Sets the server to ignore any new incoming messages (messages already in the queue are unaffected) //! \param bIgnore if true, the message queue will ignore any new messages void IgnoreAllNewMessages(bool bIgnore) { m_bIgnoreAllNewMessages = bIgnore; } Index: wg_rect.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_rect.h,v retrieving revision 1.29 retrieving revision 1.30 diff -C2 -d -r1.29 -r1.30 *** wg_rect.h 13 Apr 2004 15:28:56 -0000 1.29 --- wg_rect.h 3 Jun 2004 19:10:52 -0000 1.30 *************** *** 79,119 **** void SetBottom(const int bottom) { m_Bottom = bottom; } //! \return The Top position int Top(void) const { return m_Top; } //! \return The Left position int Left(void) const { return m_Left; } //! \return The Right position int Right(void) const { return m_Right; } //! \return The Bottom position int Bottom(void) const { return m_Bottom; } //! \return A point representing the Top Left corner of the CRect CPoint TopLeft(void) const { return CPoint(m_Left, m_Top); } //! \return A point representing the Top Right corner of the CRect CPoint TopRight(void) const { return CPoint(m_Right, m_Top); } //! \return A point representing the Bottom Left corner of the CRect CPoint BottomLeft(void) const { return CPoint(m_Left, m_Bottom); } //! \return A point representing the Bottom Right corner of the CRect CPoint BottomRight(void) const { return CPoint(m_Right, m_Bottom); } ! //! \return A point representing the center of the CRect CPoint Center(void) const { return CPoint((m_Left + m_Right) / 2, (m_Top + m_Bottom) / 2); } //! \return A point representing the CenterLeft point of the CRect CPoint CenterLeft(void) const { return CPoint( m_Left, (m_Top + m_Bottom) / 2); } //! \return A point representing the CenterTop point of the CRect CPoint CenterTop(void) const { return CPoint( (m_Left + m_Right) / 2, m_Top ); } //! \return A point representing the Bottom Left corner of the CRect CPoint CenterBottom(void) const { return CPoint( (m_Left + m_Right) / 2, m_Bottom ); } //! \return A point representing the Bottom Right corner of the CRect CPoint CenterRight(void) const { return CPoint( m_Right, (m_Top + m_Bottom) / 2); } --- 79,131 ---- void SetBottom(const int bottom) { m_Bottom = bottom; } + //! Gets the top of the rectangle //! \return The Top position int Top(void) const { return m_Top; } + //! Gets the left of the rectangle //! \return The Left position int Left(void) const { return m_Left; } + //! Gets the right of the rectangle //! \return The Right position int Right(void) const { return m_Right; } + //! Gets the bottom of the rectangle //! \return The Bottom position int Bottom(void) const { return m_Bottom; } + //! Gets the top-left corner of the rectangle //! \return A point representing the Top Left corner of the CRect CPoint TopLeft(void) const { return CPoint(m_Left, m_Top); } + //! Gets the top-right corner of the rectangle //! \return A point representing the Top Right corner of the CRect CPoint TopRight(void) const { return CPoint(m_Right, m_Top); } + //! Gets the bottom left corner of the rectangle //! \return A point representing the Bottom Left corner of the CRect CPoint BottomLeft(void) const { return CPoint(m_Left, m_Bottom); } + //! Gets the bottom-right corner of the rectangle //! \return A point representing the Bottom Right corner of the CRect CPoint BottomRight(void) const { return CPoint(m_Right, m_Bottom); } ! //! Gets the center of the rectangle //! \return A point representing the center of the CRect CPoint Center(void) const { return CPoint((m_Left + m_Right) / 2, (m_Top + m_Bottom) / 2); } + //! Gets the left side's center of the rectangle //! \return A point representing the CenterLeft point of the CRect CPoint CenterLeft(void) const { return CPoint( m_Left, (m_Top + m_Bottom) / 2); } + //! Get the top's center of the rectangle //! \return A point representing the CenterTop point of the CRect CPoint CenterTop(void) const { return CPoint( (m_Left + m_Right) / 2, m_Top ); } + //! Gets the bottom's center of the rectangle //! \return A point representing the Bottom Left corner of the CRect CPoint CenterBottom(void) const { return CPoint( (m_Left + m_Right) / 2, m_Bottom ); } + //! Gets the right side's center of the rectangle //! \return A point representing the Bottom Right corner of the CRect CPoint CenterRight(void) const { return CPoint( m_Right, (m_Top + m_Bottom) / 2); } *************** *** 124,130 **** --- 136,144 ---- SDL_Rect SDLRect(void) const; + //! Gets the width of the rectangle //! \return The width (along the X axis) of the CRect int Width(void) const { return abs(m_Right - m_Left + 1); } + //! Gets the height of the rectangle //! \return The height (along the Y axis) of the CRect int Height(void) const { return abs(m_Bottom - m_Top + 1); } *************** *** 182,186 **** }; ! //! \brief The HitTest will test to see where a point is in relation to the rect //! \param p The point to test against the CRect //! \return The appropriate values of the ERelativePosition enum are ORed together --- 196,200 ---- }; ! //! The HitTest will test to see where a point is in relation to the rect //! \param p The point to test against the CRect //! \return The appropriate values of the ERelativePosition enum are ORed together Index: wg_error.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_error.h,v retrieving revision 1.12 retrieving revision 1.13 diff -C2 -d -r1.12 -r1.13 *** wg_error.h 2 Apr 2004 17:26:13 -0000 1.12 --- wg_error.h 3 Jun 2004 19:10:52 -0000 1.13 *************** *** 39,42 **** --- 39,43 ---- { public: + //! Standard constructor //! \param sWhat A string for more information on what caused the exception Wg_Ex_Base(const std::string& sWhat) : m_sWhat(sWhat) { } *************** *** 45,51 **** --- 46,54 ---- virtual ~Wg_Ex_Base(void) throw() { } + //! Gets a text description of the exception //! \return A string describing what caused the exception virtual const char* what() const throw() { return m_sWhat.c_str(); } + //! Gets a text description of the exception //! \return A std::string reference describing what caused the exception virtual const std::string& std_what() const throw() { return m_sWhat; } *************** *** 60,63 **** --- 63,67 ---- { public: + //! Standard constructor //! \param sWhat A string for more information on what caused the exception Wg_Ex_SDL(const std::string& sWhat) : Wg_Ex_Base(sWhat) { } *************** *** 69,72 **** --- 73,77 ---- { public: + //! Standard constructor //! \param sWhat A string for more information on what caused the exception Wg_Ex_FreeType(const std::string& sWhat) : Wg_Ex_Base(sWhat) { } *************** *** 78,81 **** --- 83,87 ---- { public: + //! Standard constructor //! \param sWhat A string for more information on what caused the exception Wg_Ex_App(const std::string& sWhat) : Wg_Ex_Base(sWhat) { } *************** *** 87,90 **** --- 93,97 ---- { public: + //! Standard constructor //! \param sWhat A string for more information on what caused the exception Wg_Ex_Range(const std::string& sWhat) : Wg_Ex_Base(sWhat) { } Index: wg_menu.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_menu.h,v retrieving revision 1.32 retrieving revision 1.33 diff -C2 -d -r1.32 -r1.33 *** wg_menu.h 2 Apr 2004 17:26:14 -0000 1.32 --- wg_menu.h 3 Jun 2004 19:10:52 -0000 1.33 *************** *** 90,93 **** --- 90,94 ---- void RemoveMenuItem(int iPosition); + //! Gets the number of items in a menu //! \return The number of items in the menu int GetMenuItemCount(void) const { return stdex::safe_static_cast<int>(m_MenuItems.size()); } *************** *** 228,231 **** --- 229,233 ---- bool IsInsideChild(const CPoint& Point) const; + //! Indicates if the popup menu has any popup parents //! \return true is the Popup menu doesn't have any popup parents bool IsRootPopup(void) { return !(dynamic_cast<CPopupMenu*>(m_pParentWindow)); } Index: wg_toolbar.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_toolbar.h,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** wg_toolbar.h 3 Jun 2004 18:40:52 -0000 1.13 --- wg_toolbar.h 3 Jun 2004 19:10:52 -0000 1.14 *************** *** 73,76 **** --- 73,77 ---- void Clear(void); + //! Gets the number of items on the toolbar (including spacers) //! \return The number of buttons in the toolbar unsigned int GetButtonCount(void) { return stdex::safe_static_cast<unsigned int>(m_vpButtons.size()); } Index: wg_dropdown.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_dropdown.h,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** wg_dropdown.h 2 Apr 2004 17:26:13 -0000 1.13 --- wg_dropdown.h 3 Jun 2004 19:10:52 -0000 1.14 *************** *** 81,84 **** --- 81,85 ---- void ClearItems(void) { m_pListBox->ClearItems(); } + //! Gets the current number of items in the listbox //! \return The number of items in the list int Size(void) { return m_pListBox->Size(); } Index: wg_resource_handle.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_resource_handle.h,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** wg_resource_handle.h 2 Apr 2004 17:26:14 -0000 1.17 --- wg_resource_handle.h 3 Jun 2004 19:10:52 -0000 1.18 *************** *** 50,53 **** --- 50,54 ---- CResourceHandle(TResourceId resId); + //! A copying constructor //! \param resHandle An existing resource handle that will be cloned CResourceHandle(const CResourceHandle& resHandle); *************** *** 56,62 **** --- 57,65 ---- virtual ~CResourceHandle(void); + //! Gets the resource ID of the handle //! \return The resource ID of the handle TResourceId GetResourceId(void) { return m_ResourceId; } + //! Gets the handle's internal reference count //! \return The reference count of the handle unsigned int GetRefCount(void) { return m_RefCountMap[m_ResourceId]; } *************** *** 87,90 **** --- 90,94 ---- CBitmapResourceHandle(TResourceId resId) : CResourceHandle(resId) { } + //! A copying constructor //! \param resHandle An existing resource handle that will be cloned CBitmapResourceHandle(const CBitmapResourceHandle& resHandle) : *************** *** 94,97 **** --- 98,102 ---- virtual ~CBitmapResourceHandle(void); + //! Gets the handle's bitmap //! \return An SDL_Surface pointer (the bitmap) SDL_Surface* Bitmap(void) const; *************** *** 133,136 **** --- 138,142 ---- CStringResourceHandle(TResourceId resId) : CResourceHandle(resId) { } + //! A copying constructor //! \param resHandle An existing resource handle that will be cloned CStringResourceHandle(const CStringResourceHandle& resHandle) : *************** *** 141,144 **** --- 147,151 ---- //! Returns the string + //! \return A string const std::string String(void) const; *************** *** 169,172 **** --- 176,180 ---- //! Returns the SDL Cursor pointer + //! \return A pointer to an SDL cursor object SDL_Cursor* Cursor(void) const; Index: wg_point.h =================================================================== RCS file: /cvsroot/wgui/wgui/includes/wg_point.h,v retrieving revision 1.16 retrieving revision 1.17 diff -C2 -d -r1.16 -r1.17 *** wg_point.h 2 Apr 2004 17:26:14 -0000 1.16 --- wg_point.h 3 Jun 2004 19:10:52 -0000 1.17 *************** *** 60,66 **** --- 60,68 ---- void SetY(const int y) { m_YPos = y; } + //! Gets the X coordinate //! \return X coordinate int XPos(void) const { return m_XPos; } + //! Gets the Y coordinate //! \return Y coordinate int YPos(void) const { return m_YPos; } *************** *** 81,93 **** --- 83,99 ---- bool operator!=(const CPoint& p) const { return ((m_XPos != p.m_XPos) || (m_YPos != p.m_YPos)); } + //! Indicates if a point is to the left of the point //! \return true if the point is to the left of point p bool leftof(const CPoint& p) const { return (m_XPos < p.m_XPos); } + //! Indicates if a point is to the right of the point //! \return true if the point is to the right of point p bool rightof(const CPoint& p) const { return (m_XPos > p.m_XPos); } + //! Indicates if a point is above the point //! \return true if the point is above point p bool above(const CPoint& p) const { return (m_YPos < p.m_YPos); } + //! Indicates if a point is below the point //! \return true if the point is below point p bool below(const CPoint& p) const { return (m_YPos > p.m_YPos); } |
