]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/iconbndl.tex
Added missing brace in checkbox.tex
[wxWidgets.git] / docs / latex / wx / iconbndl.tex
1 \section{\class{wxIconBundle}}\label{wxiconbundle}
2
3 This class contains multiple copies of an icon in different sizes,
4 see also \helpref{wxDialog::SetIcons}{wxdialogseticons} and
5 \helpref{wxFrame::SetIcons}{wxframeseticons}.
6
7 \wxheading{Derived from}
8
9 No base class
10
11 \latexignore{\rtfignore{\wxheading{Members}}}
12
13 \membersection{wxIconBundle::wxIconBundle}\label{wxiconbundlewxiconbundle}
14
15 \func{}{wxIconBundle}{\void}
16
17 Default constructor.
18
19 \func{}{wxIconBundle}{\param{const wxString\& }{file}, \param{long }{type}}
20
21 Initializes the bundle with the icon(s) found in the file.
22
23 \func{}{wxIconBundle}{\param{const wxIcon\& }{icon}}
24
25 Initializes the bundle with a single icon.
26
27 \func{}{wxIconBundle}{\param{const wxIconBundle\& }{ic}}
28
29 Copy constructor.
30
31 \membersection{wxIconBundle::\destruct{wxIconBundle}}\label{wxiconbundledtor}
32
33 \func{}{\destruct{wxIconBundle}}{\void}
34
35 Destructor.
36
37 \membersection{wxIconBundle::AddIcon}\label{wxiconbundleaddicon}
38
39 \func{void}{AddIcon}{\param{const wxString\& }{file}, \param{long }{type}}
40
41 Adds all the icons contained in the file to the bundle;
42 if the collection already contains icons with the same
43 width and height, they are replaced by the new ones.
44
45 \func{void}{AddIcon}{\param{const wxIcon\& }{icon}}
46
47 Adds the icon to the collection; if the collection already
48 contains an icon with the same width and height, it is
49 replaced by the new one.
50
51 \membersection{wxIconBundle::GetIcon}\label{wxiconbundlegeticon}
52
53 \constfunc{const wxIcon\&}{GetIcon}{\param{const wxSize\& }{size}}
54
55 Returns the icon with the given size; if no such icon exists,
56 returns the icon with size wxSYS\_ICON\_X/wxSYS\_ICON\_Y;
57 if no such icon exists,
58 returns the first icon in the bundle. If size = wxSize( -1, -1 ),
59 returns the icon with size wxSYS\_ICON\_X/wxSYS\_ICON\_Y.
60
61 \constfunc{const wxIcon\&}{GetIcon}{\param{wxCoord }{size = -1}}
62
63 Same as GetIcon( wxSize( size, size ) ).
64
65 \membersection{wxIconBundle::operator=}\label{wxiconbundleoperatorassign}
66
67 \func{const wxIconBundle\&}{operator=}{\param{const wxIconBundle\& }{ic}}