added wxIconLocation; minor fixes to wxIcon on some platforms

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@21279 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2003-06-21 13:39:40 +00:00
parent 75f7af39d1
commit aaf7ab431b
16 changed files with 224 additions and 44 deletions

View File

@@ -157,6 +157,7 @@
\input http.tex
\input icon.tex
\input iconbndl.tex
\input iconloc.tex
\input iconevt.tex
\input idleevt.tex
\input image.tex

View File

@@ -85,6 +85,10 @@ Creates an icon from XPM data.
Loads an icon from a file or resource.
\func{}{wxIcon}{\param{const wxIconLocation\& }{loc}}
Loads an icon from the specified \helpref{location}{wxiconlocation}.
\wxheading{Parameters}
\docparam{bits}{Specifies an array of pixel values.}
@@ -107,6 +111,9 @@ screen is used.}
\docparam{name}{This can refer to a resource name under MS Windows, or a filename under MS Windows and X.
Its meaning is determined by the {\it flags} parameter.}
\docparam{loc}{The object describing the location of the native icon, see
\helpref{wxIconLocation}{wxiconlocation}.}
\docparam{type}{May be one of the following:
\twocolwidtha{5cm}

47
docs/latex/wx/iconloc.tex Normal file
View File

@@ -0,0 +1,47 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name: iconloc.tex
%% Purpose: wxIconLocation documentation
%% Author: Vadim Zeitlin
%% Modified by:
%% Created: 21.06.03
%% RCS-ID: $Id$
%% Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxIconLocation}}\label{wxiconlocation}
wxIconLocation is a tiny class describing the location of an (external, i.e.
not embedded into the application resources) icon. For most platforms it simply
contains the file name but under some others (notably Windows) the same file
may contain multiple icons and so this class also stores the index of the icon
inside the file.
In any case, its details should be of no interest to the application code and
most of them are not even documented here (on purpose) as it is only meant to
be used as an opaque class: the application may get the object of this class
from somewhere and the only reasonable thing to do with it later is to create
a \helpref{wxIcon}{wxicon} from it.
\wxheading{Derived from}
None.
\wxheading{Include files}
<wx/iconloc.h>
\wxheading{See also}
\wxheading{wxIcon}{wxicon}, \helpref{wxFileType::GetIcon()}{wxfiletypegeticon}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxIconLocation::IsOk}\label{wxiconlocationisok}
\constfunc{bool}{IsOk}{\void}
Returns {\tt true} if the object is valid, i.e. was properly initialized, and
{\tt false} otherwise.