Fix "depreciated" to "deprecated".

[wxWidgets.git] / docs / latex / wx / iconbndl.tex

\section{\class{wxIconBundle}}\label{wxiconbundle}

This class contains multiple copies of an icon in different sizes,
see also \helpref{wxDialog::SetIcons}{wxdialogseticons} and
\helpref{wxTopLevelWindow::SetIcons}{wxtoplevelwindowseticons}.

\wxheading{Derived from}

\helpref{wxGDIObject}{wxgdiobject}\\
\helpref{wxObject}{wxobject}

\wxheading{Predefined objects}

{\bf wxNullIconBundle}

\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxIconBundle::wxIconBundle}\label{wxiconbundlewxiconbundle}

\func{}{wxIconBundle}{\void}

Default constructor.

\func{}{wxIconBundle}{\param{const wxString\& }{file}, \param{long }{type}}

Initializes the bundle with the icon(s) found in the file.

\func{}{wxIconBundle}{\param{const wxIcon\& }{icon}}

Initializes the bundle with a single icon.

\func{}{wxIconBundle}{\param{const wxIconBundle\& }{ic}}

Copy constructor.


\membersection{wxIconBundle::\destruct{wxIconBundle}}\label{wxiconbundledtor}

\func{}{\destruct{wxIconBundle}}{\void}

Destructor.


\membersection{wxIconBundle::AddIcon}\label{wxiconbundleaddicon}

\func{void}{AddIcon}{\param{const wxString\& }{file}, \param{long }{type}}

Adds all the icons contained in the file to the bundle;
if the collection already contains icons with the same
width and height, they are replaced by the new ones.

\func{void}{AddIcon}{\param{const wxIcon\& }{icon}}

Adds the icon to the collection; if the collection already
contains an icon with the same width and height, it is
replaced by the new one.


\membersection{wxIconBundle::GetIcon}\label{wxiconbundlegeticon}

\constfunc{wxIcon}{GetIcon}{\param{const wxSize\& }{size}}

Returns the icon with the given size; if no such icon exists,
returns the icon with size wxSYS\_ICON\_X/wxSYS\_ICON\_Y;
if no such icon exists,
returns the first icon in the bundle. If size = wxSize( -1, -1 ),
returns the icon with size wxSYS\_ICON\_X/wxSYS\_ICON\_Y.

\constfunc{wxIcon}{GetIcon}{\param{wxCoord }{size = -1}}

Same as GetIcon( wxSize( size, size ) ).


\membersection{wxIconBundle::GetIconOfExactSize}\label{wxiconbundlegeticonofexactsize}

\constfunc{wxIcon}{GetIconOfExactSize}{\param{const wxSize\& }{size}}

Returns the icon with exactly the given size or \texttt{wxNullIcon} if this
size is not available.


\membersection{wxIconBundle::IsEmpty}\label{wxiconbundleisempty}

\constfunc{bool}{IsEmpty}{\void}

Returns \true if the bundle doesn't contain any icons, \false otherwise (in
which case a call to \helpref{GetIcon()}{wxiconbundlegeticon} with default
parameter should return a valid icon).


\membersection{wxIconBundle::operator $=$}\label{wxiconbundleoperatorassign}

\func{wxIconBundle\&}{operator $=$}{\param{const wxIconBundle\& }{ic}}

Assignment operator, using \helpref{reference counting}{trefcount}.


\membersection{wxIconBundle::operator $==$}\label{wxiconbundleoperatorequals}

\func{bool}{operator $==$}{\param{const wxIconBundle\& }{ic}}

Equality operator. This returns \true if two icon bundles are equal.


\membersection{wxIconBundle::operator $!=$}\label{wxiconbundleoperatornotequals}

\func{bool}{operator $!=$}{\param{const wxIconBundle\& }{ic}}

Inequality operator. This returns \true if two icon bundles are not equal.