git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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{Predefined objects}
	13
	14	{\bf wxNullIconBundle}
	15
	16	\latexignore{\rtfignore{\wxheading{Members}}}
	17
	18
	19	\membersection{wxIconBundle::wxIconBundle}\label{wxiconbundlewxiconbundle}
	20
	21	\func{}{wxIconBundle}{\void}
	22
	23	Default constructor.
	24
	25	\func{}{wxIconBundle}{\param{const wxString\& }{file}, \param{long }{type}}
	26
	27	Initializes the bundle with the icon(s) found in the file.
	28
	29	\func{}{wxIconBundle}{\param{const wxIcon\& }{icon}}
	30
	31	Initializes the bundle with a single icon.
	32
	33	\func{}{wxIconBundle}{\param{const wxIconBundle\& }{ic}}
	34
	35	Copy constructor.
	36
	37
	38	\membersection{wxIconBundle::\destruct{wxIconBundle}}\label{wxiconbundledtor}
	39
	40	\func{}{\destruct{wxIconBundle}}{\void}
	41
	42	Destructor.
	43
	44
	45	\membersection{wxIconBundle::AddIcon}\label{wxiconbundleaddicon}
	46
	47	\func{void}{AddIcon}{\param{const wxString\& }{file}, \param{long }{type}}
	48
	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.
	52
	53	\func{void}{AddIcon}{\param{const wxIcon\& }{icon}}
	54
	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.
	58
	59
	60	\membersection{wxIconBundle::GetIcon}\label{wxiconbundlegeticon}
	61
	62	\constfunc{wxIcon}{GetIcon}{\param{const wxSize\& }{size}}
	63
	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.
	69
	70	\constfunc{wxIcon}{GetIcon}{\param{wxCoord }{size = -1}}
	71
	72	Same as GetIcon( wxSize( size, size ) ).
	73
	74
	75	\membersection{wxIconBundle::GetIconOfExactSize}\label{wxiconbundlegeticonofexactsize}
	76
	77	\constfunc{wxIcon}{GetIconOfExactSize}{\param{const wxSize\& }{size}}
	78
	79	Returns the icon with exactly the given size or \texttt{wxNullIcon} if this
	80	size is not available.
	81
	82
	83	\membersection{wxIconBundle::IsEmpty}\label{wxiconbundleisempty}
	84
	85	\constfunc{bool}{IsEmpty}{\void}
	86
	87	Returns \true if the bundle doesn't contain any icons, \false otherwise (in
	88	which case a call to \helpref{GetIcon()}{wxiconbundlegeticon} with default
	89	parameter should return a valid icon).
	90
	91
	92	\membersection{wxIconBundle::operator $=$}\label{wxiconbundleoperatorassign}
	93
	94	\func{wxIconBundle\&}{operator $=$}{\param{const wxIconBundle\& }{ic}}
	95
	96	Assignment operator, using \helpref{reference counting}{trefcount}.
	97
	98
	99	\membersection{wxIconBundle::operator $==$}\label{wxiconbundleoperatorequals}
	100
	101	\func{bool}{operator $==$}{\param{const wxIconBundle\& }{ic}}
	102
	103	Equality operator. This returns \true if two icon bundles are equal.
	104
	105
	106	\membersection{wxIconBundle::operator $!=$}\label{wxiconbundleoperatornotequals}
	107
	108	\func{bool}{operator $!=$}{\param{const wxIconBundle\& }{ic}}
	109
	110	Inequality operator. This returns \true if two icon bundles are not equal.