Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
87
interface/wx/position.h
Normal file
87
interface/wx/position.h
Normal file
@@ -0,0 +1,87 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: position.h
|
||||
// Purpose: interface of wxPosition
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@class wxPosition
|
||||
@wxheader{position.h}
|
||||
|
||||
This class represents the position of an item in any kind of grid of rows and
|
||||
columns such as wxGridBagSizer, or wxHVScrolledWindow.
|
||||
|
||||
@todo rename this class to wxItemPosition or such, wxPosition is too generic
|
||||
|
||||
@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& p) const;
|
||||
bool operator !=(const wxPosition& p) const;
|
||||
wxPosition& operator +=(const wxPosition& p) const;
|
||||
wxPosition& operator -=(const wxPosition& p) const;
|
||||
wxPosition& operator +=(const wxSize& s) const;
|
||||
wxPosition& operator -=(const wxSize& s) const;
|
||||
wxPosition& operator +(const wxPosition& p) const;
|
||||
wxPosition& operator -(const wxPosition& p) const;
|
||||
wxPosition& operator +(const wxSize& s) const;
|
||||
wxPosition& operator -(const wxSize& s) const;
|
||||
//@}
|
||||
};
|
||||
|
Reference in New Issue
Block a user