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