X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ba637f22e61113ab2296936f9a101e929cc05711..a0c2e4a050f4f2e8d344483ba4cfaa8b08a1fe87:/docs/latex/wx/iconbndl.tex diff --git a/docs/latex/wx/iconbndl.tex b/docs/latex/wx/iconbndl.tex index 33552d65b6..a58e3722e6 100644 --- a/docs/latex/wx/iconbndl.tex +++ b/docs/latex/wx/iconbndl.tex @@ -2,14 +2,28 @@ This class contains multiple copies of an icon in different sizes, see also \helpref{wxDialog::SetIcons}{wxdialogseticons} and -\helpref{wxFrame::SetIcons}{wxframeseticons}. +\helpref{wxTopLevelWindow::SetIcons}{wxtoplevelwindowseticons}. \wxheading{Derived from} -No base class +\helpref{wxGDIObject}{wxgdiobject}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + +\wxheading{Predefined objects} + +{\bf wxNullIconBundle} \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxIconBundle::wxIconBundle}\label{wxiconbundlewxiconbundle} \func{}{wxIconBundle}{\void} @@ -28,12 +42,14 @@ Initializes the bundle with a single icon. 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}} @@ -48,9 +64,10 @@ 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{const wxIcon\&}{GetIcon}{\param{const wxSize\& }{size}} +\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; @@ -58,13 +75,44 @@ 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{const wxIcon\&}{GetIcon}{\param{wxCoord }{size = -1}} +\constfunc{wxIcon}{GetIcon}{\param{wxCoord }{size = -1}} Same as GetIcon( wxSize( size, size ) ). -\membersection{wxIconBundle::operator=}\label{wxiconbundleoperatorassign} -\func{const wxIconBundle\&}{operator=}{\param{const wxIconBundle\& }{ic}} +\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} -Assignment operator. +\func{bool}{operator $!=$}{\param{const wxIconBundle\& }{ic}} +Inequality operator. This returns \true if two icon bundles are not equal.