]>
Commit | Line | Data |
---|---|---|
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 | ||
38 | \membersection{wxSize::DecTo}\label{wxsizedecto} | |
39 | ||
40 | \func{wxSize\&}{DecTo}{\param{const wxSize\& }{size}} | |
41 | ||
42 | Decrements this object so that both of its dimensions are not greater than the | |
43 | corresponding dimensions of the \arg{size}. | |
44 | ||
45 | \wxheading{See also} | |
46 | ||
47 | \helpref{IncTo}{wxsizeincto} | |
48 | ||
49 | ||
50 | \membersection{wxSize::GetWidth}\label{wxsizegetwidth} | |
51 | ||
52 | \constfunc{int}{GetWidth}{\void} | |
53 | ||
54 | Gets the width member. | |
55 | ||
56 | \membersection{wxSize::GetHeight}\label{wxsizegetheight} | |
57 | ||
58 | \constfunc{int}{GetHeight}{\void} | |
59 | ||
60 | Gets the height member. | |
61 | ||
62 | ||
63 | \membersection{wxSize::IncTo}\label{wxsizeincto} | |
64 | ||
65 | \func{wxSize\&}{IncTo}{\param{const wxSize\& }{size}} | |
66 | ||
67 | Increments this object so that both of its dimensions are not less than the | |
68 | corresponding dimensions of the \arg{size}. | |
69 | ||
70 | \wxheading{See also} | |
71 | ||
72 | \helpref{DecTo}{wxsizedecto} | |
73 | ||
74 | ||
75 | \membersection{wxSize::Set}\label{wxsizeset} | |
76 | ||
77 | \func{void}{Set}{\param{int}{ width}, \param{int}{ height}} | |
78 | ||
79 | Sets the width and height members. | |
80 | ||
81 | \membersection{wxSize::SetHeight}\label{wxsizesetheight} | |
82 | ||
83 | \func{void}{SetHeight}{\param{int}{ height}} | |
84 | ||
85 | Sets the height. | |
86 | ||
87 | \membersection{wxSize::SetWidth}\label{wxsizesetwidth} | |
88 | ||
89 | \func{void}{SetWidth}{\param{int}{ width}} | |
90 | ||
91 | Sets the width. | |
92 | ||
93 | \membersection{wxSize::operator $=$} | |
94 | ||
95 | \func{void}{operator $=$}{\param{const wxSize\& }{sz}} | |
96 | ||
97 | Assignment operator. | |
98 | ||
99 |