docs/latex/wx/position.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        position.tex (moved from gbposition.tex)
   3 %% Purpose:     wxPosition Documentation
   4 %% Author:      Robin Dunn, Bryan Petty
   5 %% Modified by:
   6 %% Created:     2003-11-06, modified 2007-04-05
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) 2003, 2007 wxWidgets Team
   9 %% License:     wxWindows Licence
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxPosition}}\label{wxposition}
  13
  14 This class represents the position of an item in any kind of grid of rows and
  15 columns such as \helpref{wxGridBagSizer}{wxgridbagsizer}, or
  16 \helpref{wxHVScrolledWindow}{wxhvscrolledwindow}.
  17
  18 \wxheading{Derived from}
  19
  20 No base class
  21
  22 \wxheading{Include files}
  23
  24 <wx/position.h>
  25
  26 \wxheading{See also}
  27
  28 \helpref{wxPoint}{wxpoint}, \helpref{wxSize}{wxsize}
  29
  30 \latexignore{\rtfignore{\wxheading{Members}}}
  31
  32
  33 \membersection{wxPosition::wxPosition}\label{wxpositionwxposition}
  34
  35 \func{}{wxPosition}{\void}
  36
  37 \func{}{wxPosition}{\param{int }{row}, \param{int }{col}}
  38
  39 Construct a new wxPosition, optionally setting the row and column. The
  40 default value is $(0, 0)$.
  41
  42
  43 \membersection{wxPosition::GetCol}\label{wxpositiongetcol}
  44
  45 \constfunc{int}{GetCol}{\void}
  46
  47 A synonym for \helpref{GetColumn()}{wxpositiongetcolumn}.
  48
  49
  50 \membersection{wxPosition::GetColumn}\label{wxpositiongetcolumn}
  51
  52 \constfunc{int}{GetColumn}{\void}
  53
  54 Get the current row value.
  55
  56
  57 \membersection{wxPosition::GetRow}\label{wxpositiongetrow}
  58
  59 \constfunc{int}{GetRow}{\void}
  60
  61 Get the current row value.
  62
  63
  64 \membersection{wxPosition::SetCol}\label{wxpositionsetcol}
  65
  66 \func{void}{SetCol}{\param{int }{column}}
  67
  68 A synonym for \helpref{SetColumn()}{wxpositionsetcolumn}.
  69
  70
  71 \membersection{wxPosition::SetColumn}\label{wxpositionsetcolumn}
  72
  73 \func{void}{SetColumn}{\param{int }{column}}
  74
  75 Set a new column value.
  76
  77
  78 \membersection{wxPosition::SetRow}\label{wxpositionsetrow}
  79
  80 \func{void}{SetRow}{\param{int }{row}}
  81
  82 Set a new row value.
  83
  84
  85 \membersection{Operators}\label{wxpositionoperators}
  86
  87 \constfunc{bool}{operator $==$}{\param{const wxPosition\& }{p}}
  88
  89 \constfunc{bool}{operator $!=$}{\param{const wxPosition\& }{p}}
  90
  91 Compare equality of two wxPositions.
  92
  93 \func{wxPosition\&}{operator $+=$}{\param{const wxPosition\& }{p}}
  94
  95 \func{wxPosition\&}{operator $-=$}{\param{const wxPosition\& }{p}}
  96
  97 \func{wxPosition\&}{operator $+=$}{\param{const wxSize\& }{s}}
  98
  99 \func{wxPosition\&}{operator $-=$}{\param{const wxSize\& }{s}}
 100
 101 \constfunc{wxPosition}{operator $+$}{\param{const wxPosition\& }{p}}
 102
 103 \constfunc{wxPosition}{operator $-$}{\param{const wxPosition\& }{p}}
 104
 105 \constfunc{wxPosition}{operator $+$}{\param{const wxSize\& }{s}}
 106
 107 \constfunc{wxPosition}{operator $-$}{\param{const wxSize\& }{s}}
 108