docs/latex/wx/size.tex

   1 \section{\class{wxSize}}\label{wxsize}
   2
   3 A {\bf wxSize} is a useful data structure for graphics operations.
   4 It simply contains integer {\it x} and {\it y} members.
   5
   6 \pythonnote{wxPython defines aliases for the \tt{x} and \tt{y} members
   7 named \tt{width} and \tt{height} since it makes much more sense for
   8 sizes.  There is also coresponding aliases for the  \tt{GetWidth} and
   9 \tt{GetHeight} methods.
  10 }
  11
  12 \wxheading{Derived from}
  13
  14 None
  15
  16 \wxheading{Include files}
  17
  18 <wx/gdicmn.h>
  19
  20 \wxheading{See also}
  21
  22 \helpref{wxPoint}{wxpoint}, \helpref{wxRealPoint}{wxrealpoint}
  23
  24 \latexignore{\rtfignore{\wxheading{Members}}}
  25
  26 \membersection{wxSize::wxSize}
  27
  28 \func{}{wxSize}{\void}
  29
  30 \func{}{wxSize}{\param{int}{ x}, \param{int}{ y}}
  31
  32 Creates a size object.
  33
  34 \membersection{wxSize::x}
  35
  36 \member{int}{x}
  37
  38 x member.
  39
  40 \membersection{wxSize::y}
  41
  42 \member{int}{ y}
  43
  44 y member.
  45
  46 \membersection{wxSize::GetX}\label{wxsizegetx}
  47
  48 \constfunc{int}{GetX}{\void}
  49
  50 Gets the x member.
  51
  52 \membersection{wxSize::GetY}\label{wxsizegety}
  53
  54 \constfunc{int}{GetY}{\void}
  55
  56 Gets the y member.
  57
  58 \membersection{wxSize::Set}\label{wxsizeset}
  59
  60 \func{void}{Set}{\param{int}{ x}, \param{int}{ y}}
  61
  62 Sets the x and y members.
  63
  64 \membersection{wxSize::operator $=$}
  65
  66 \func{void}{operator $=$}{\param{const wxSize\& }{sz}}
  67
  68 Assignment operator.
  69
  70