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 width} and {\it height} members.
   5
   6 wxSize is used throughout wxWindows as well as wxPoint which, although almost
   7 equivalent to wxSize, has a different meaning: wxPoint represents a position
   8 while wxSize - the size.
   9
  10 \pythonnote{wxPython defines aliases for the \tt{x} and \tt{y} members
  11 named \tt{width} and \tt{height} since it makes much more sense for
  12 sizes.
  13 }
  14
  15 \wxheading{Derived from}
  16
  17 None
  18
  19 \wxheading{Include files}
  20
  21 <wx/gdicmn.h>
  22
  23 \wxheading{See also}
  24
  25 \helpref{wxPoint}{wxpoint}, \helpref{wxRealPoint}{wxrealpoint}
  26
  27 \latexignore{\rtfignore{\wxheading{Members}}}
  28
  29 \membersection{wxSize::wxSize}
  30
  31 \func{}{wxSize}{\void}
  32
  33 \func{}{wxSize}{\param{int}{ width}, \param{int}{ height}}
  34
  35 Creates a size object.
  36
  37 \membersection{wxSize::GetWidth}\label{wxsizegetwidth}
  38
  39 \constfunc{int}{GetWidth}{\void}
  40
  41 Gets the width member.
  42
  43 \membersection{wxSize::GetHeight}\label{wxsizegetheight}
  44
  45 \constfunc{int}{GetHeight}{\void}
  46
  47 Gets the height member.
  48
  49 \membersection{wxSize::Set}\label{wxsizeset}
  50
  51 \func{void}{Set}{\param{int}{ width}, \param{int}{ height}}
  52
  53 Sets the width and height members.
  54
  55 \membersection{wxSize::SetHeight}\label{wxsizesetheight}
  56
  57 \func{void}{SetHeight}{\param{int}{ height}}
  58
  59 Sets the height.
  60
  61 \membersection{wxSize::SetWidth}\label{wxsizesetwidth}
  62
  63 \func{void}{SetWidth}{\param{int}{ width}}
  64
  65 Sets the width.
  66
  67 \membersection{wxSize::operator $=$}
  68
  69 \func{void}{operator $=$}{\param{const wxSize\& }{sz}}
  70
  71 Assignment operator.
  72
  73