wxwidgets/interface/wx/position.h
Vadim Zeitlin 8ac10d28f8 Fix all the other comments with Doxygen grouping commands too
This is the same thing as bd92523bc5 (Fix use of Doxygen @addtogroup
command, 2022-08-03) except it fixes comments format for all the other
occurrences of "@{" and "@}" too, not just for those used with
@addtogroup which was the problem in #22572.

This fixes many different formatting problems due to attaching various
Doxygen commands to wrong elements because of broken grouping, e.g. all
overloaded functions were documented incorrectly and there were several
problems in wxString documentation.

See #22248.
2022-08-03 18:58:47 +02:00

83 lines
1.9 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: position.h
// Purpose: interface of wxPosition
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxPosition
This class represents the position of an item in any kind of grid of rows and
columns such as wxGridBagSizer, or wxHVScrolledWindow.
@library{wxbase}
@category{data}
@see wxPoint, wxSize
*/
class wxPosition
{
public:
/**
Construct a new wxPosition, setting the row and column to the
default value of (0, 0).
*/
wxPosition();
/**
Construct a new wxPosition, setting the row and column to the
value of (@a row, @a col).
*/
wxPosition(int row, int col);
/**
A synonym for GetColumn().
*/
int GetCol() const;
/**
Get the current row value.
*/
int GetColumn() const;
/**
Get the current row value.
*/
int GetRow() const;
/**
A synonym for SetColumn().
*/
void SetCol(int column);
/**
Set a new column value.
*/
void SetColumn(int column);
/**
Set a new row value.
*/
void SetRow(int row);
/**
@name Miscellaneous operators
@{
*/
bool operator ==(const wxPosition& pos) const;
bool operator !=(const wxPosition& pos) const;
wxPosition& operator +=(const wxPosition& pos);
wxPosition& operator -=(const wxPosition& pos);
wxPosition& operator +=(const wxSize& size);
wxPosition& operator -=(const wxSize& size);
wxPosition operator +(const wxPosition& pos) const;
wxPosition operator -(const wxPosition& pos) const;
wxPosition operator +(const wxSize& size) const;
wxPosition operator -(const wxSize& size) const;
///@}
};