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{wxTopLevelWindow::SetIcons}{wxtoplevelwindowseticons}.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxGDIObject}{wxgdiobject}\\
  10 \helpref{wxObject}{wxobject}
  11
  12 \wxheading{Include files}
  13
  14 <wx/iconbndl.h>
  15
  16 \wxheading{Predefined objects}
  17
  18 {\bf wxNullIconBundle}
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22
  23 \membersection{wxIconBundle::wxIconBundle}\label{wxiconbundlewxiconbundle}
  24
  25 \func{}{wxIconBundle}{\void}
  26
  27 Default constructor.
  28
  29 \func{}{wxIconBundle}{\param{const wxString\& }{file}, \param{long }{type}}
  30
  31 Initializes the bundle with the icon(s) found in the file.
  32
  33 \func{}{wxIconBundle}{\param{const wxIcon\& }{icon}}
  34
  35 Initializes the bundle with a single icon.
  36
  37 \func{}{wxIconBundle}{\param{const wxIconBundle\& }{ic}}
  38
  39 Copy constructor.
  40
  41
  42 \membersection{wxIconBundle::\destruct{wxIconBundle}}\label{wxiconbundledtor}
  43
  44 \func{}{\destruct{wxIconBundle}}{\void}
  45
  46 Destructor.
  47
  48
  49 \membersection{wxIconBundle::AddIcon}\label{wxiconbundleaddicon}
  50
  51 \func{void}{AddIcon}{\param{const wxString\& }{file}, \param{long }{type}}
  52
  53 Adds all the icons contained in the file to the bundle;
  54 if the collection already contains icons with the same
  55 width and height, they are replaced by the new ones.
  56
  57 \func{void}{AddIcon}{\param{const wxIcon\& }{icon}}
  58
  59 Adds the icon to the collection; if the collection already
  60 contains an icon with the same width and height, it is
  61 replaced by the new one.
  62
  63
  64 \membersection{wxIconBundle::GetIcon}\label{wxiconbundlegeticon}
  65
  66 \constfunc{wxIcon}{GetIcon}{\param{const wxSize\& }{size}}
  67
  68 Returns the icon with the given size; if no such icon exists,
  69 returns the icon with size wxSYS\_ICON\_X/wxSYS\_ICON\_Y;
  70 if no such icon exists,
  71 returns the first icon in the bundle. If size = wxSize( -1, -1 ),
  72 returns the icon with size wxSYS\_ICON\_X/wxSYS\_ICON\_Y.
  73
  74 \constfunc{wxIcon}{GetIcon}{\param{wxCoord }{size = -1}}
  75
  76 Same as GetIcon( wxSize( size, size ) ).
  77
  78
  79 \membersection{wxIconBundle::GetIconOfExactSize}\label{wxiconbundlegeticonofexactsize}
  80
  81 \constfunc{wxIcon}{GetIconOfExactSize}{\param{const wxSize\& }{size}}
  82
  83 Returns the icon with exactly the given size or \texttt{wxNullIcon} if this
  84 size is not available.
  85
  86
  87 \membersection{wxIconBundle::IsEmpty}\label{wxiconbundleisempty}
  88
  89 \constfunc{bool}{IsEmpty}{\void}
  90
  91 Returns \true if the bundle doesn't contain any icons, \false otherwise (in
  92 which case a call to \helpref{GetIcon()}{wxiconbundlegeticon} with default
  93 parameter should return a valid icon).
  94
  95
  96 \membersection{wxIconBundle::operator $=$}\label{wxiconbundleoperatorassign}
  97
  98 \func{wxIconBundle\&}{operator $=$}{\param{const wxIconBundle\& }{ic}}
  99
 100 Assignment operator, using \helpref{reference counting}{trefcount}.
 101
 102
 103 \membersection{wxIconBundle::operator $==$}\label{wxiconbundleoperatorequals}
 104
 105 \func{bool}{operator $==$}{\param{const wxIconBundle\& }{ic}}
 106
 107 Equality operator. This returns \true if two icon bundles are equal.
 108
 109
 110 \membersection{wxIconBundle::operator $!=$}\label{wxiconbundleoperatornotequals}
 111
 112 \func{bool}{operator $!=$}{\param{const wxIconBundle\& }{ic}}
 113
 114 Inequality operator. This returns \true if two icon bundles are not equal.