wxWidgets/interface/wx/position.h
Vadim Zeitlin ccba6d73f9 Fix use of Doxygen grouping
Fix wrong use of Doxygen grouping-related markup which somehow worked in
older Doxygen versions, but doesn't work any longer.

This fixes the problem with the "Functions by Category" pages being
empty in the resulting HTML documentation and wrong documentation being
shown for a bunch of wxString members.

This is a combined cherry-pick of the following master commits:

bd92523bc5 Fix use of Doxygen @addtogroup command
4c46e01b14 Remove stray Doxygen end group marker
8ac10d28f8 Fix all the other comments with Doxygen grouping commands too
c0f1ecf263 Fix another unbalanced Doxygen grouping command after last commit

See #22248, #22572.
2022-08-18 19:15:47 +02:00

84 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;
///@}
};