1 \section{\class{wxIconBundle
}}\label{wxiconbundle
}
3 This class contains multiple copies of an icon in different sizes,
4 see also
\helpref{wxDialog::SetIcons
}{wxdialogseticons
} and
5 \helpref{wxTopLevelWindow::SetIcons
}{wxtoplevelwindowseticons
}.
7 \wxheading{Derived from
}
9 \helpref{wxGDIObject
}{wxgdiobject
}\\
10 \helpref{wxObject
}{wxobject
}
12 \wxheading{Predefined objects
}
14 {\bf wxNullIconBundle
}
16 \latexignore{\rtfignore{\wxheading{Members
}}}
19 \membersection{wxIconBundle::wxIconBundle
}\label{wxiconbundlewxiconbundle
}
21 \func{}{wxIconBundle
}{\void}
25 \func{}{wxIconBundle
}{\param{const wxString\&
}{file
},
\param{long
}{type
}}
27 Initializes the bundle with the icon(s) found in the file.
29 \func{}{wxIconBundle
}{\param{const wxIcon\&
}{icon
}}
31 Initializes the bundle with a single icon.
33 \func{}{wxIconBundle
}{\param{const wxIconBundle\&
}{ic
}}
38 \membersection{wxIconBundle::
\destruct{wxIconBundle
}}\label{wxiconbundledtor
}
40 \func{}{\destruct{wxIconBundle
}}{\void}
45 \membersection{wxIconBundle::AddIcon
}\label{wxiconbundleaddicon
}
47 \func{void
}{AddIcon
}{\param{const wxString\&
}{file
},
\param{long
}{type
}}
49 Adds all the icons contained in the file to the bundle;
50 if the collection already contains icons with the same
51 width and height, they are replaced by the new ones.
53 \func{void
}{AddIcon
}{\param{const wxIcon\&
}{icon
}}
55 Adds the icon to the collection; if the collection already
56 contains an icon with the same width and height, it is
57 replaced by the new one.
60 \membersection{wxIconBundle::GetIcon
}\label{wxiconbundlegeticon
}
62 \constfunc{wxIcon
}{GetIcon
}{\param{const wxSize\&
}{size
}}
64 Returns the icon with the given size; if no such icon exists,
65 returns the icon with size wxSYS
\_ICON\_X/wxSYS
\_ICON\_Y;
66 if no such icon exists,
67 returns the first icon in the bundle. If size = wxSize( -
1, -
1 ),
68 returns the icon with size wxSYS
\_ICON\_X/wxSYS
\_ICON\_Y.
70 \constfunc{wxIcon
}{GetIcon
}{\param{wxCoord
}{size = -
1}}
72 Same as GetIcon( wxSize( size, size ) ).
75 \membersection{wxIconBundle::IsEmpty
}\label{wxiconbundleisempty
}
77 \constfunc{bool
}{IsEmpty
}{\void}
79 Returns
\true if the bundle doesn't contain any icons,
\false otherwise (in
80 which case a call to
\helpref{GetIcon()
}{wxiconbundlegeticon
} with default
81 parameter should return a valid icon).
84 \membersection{wxIconBundle::operator $=$
}\label{wxiconbundleoperatorassign
}
86 \func{wxIconBundle\&
}{operator $=$
}{\param{const wxIconBundle\&
}{ic
}}
88 Assignment operator, using
\helpref{reference counting
}{trefcount
}.
91 \membersection{wxIconBundle::operator $==$
}\label{wxiconbundleoperatorequals
}
93 \func{bool
}{operator $==$
}{\param{const wxIconBundle\&
}{ic
}}
95 Equality operator. This returns
\true if two icon bundles are equal.
98 \membersection{wxIconBundle::operator $!=$
}\label{wxiconbundleoperatornotequals
}
100 \func{bool
}{operator $!=$
}{\param{const wxIconBundle\&
}{ic
}}
102 Inequality operator. This returns
\true if two icon bundles are not equal.