Docs for wxDialog/wxFrame::SetIcons and wxIconBundle.
\verb$ $ -> \tt{ } ( as per tex2rtf suggestion ).
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@14806 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Mattia Barbon
parent
0c874f87e5
commit
9a6a553013
@ -511,7 +511,7 @@ Some are under the 'contrib' hierarchy which mirrors the
|
||||
structure of the main wxWindows hierarchy. See also the 'utils'
|
||||
hierarchy. The first place to look for documentation about
|
||||
these tools and libraries is under the wxWindows 'docs' hierarchy,
|
||||
for example \verb$docs/htmlhelp/fl.chm$.
|
||||
for example \tt{docs/htmlhelp/fl.chm}.
|
||||
|
||||
For other user-contributed packages, please see the Contributions page
|
||||
on the \urlref{wxWindows Web site}{http://www.wxwindows.org}.
|
||||
@ -522,7 +522,7 @@ Helpview is a program for displaying wxWindows HTML
|
||||
Help files. In many cases, you may wish to use the wxWindows HTML
|
||||
Help classes from within your application, but this provides a
|
||||
handy stand-alone viewer. See \helpref{wxHTML Notes}{wxhtml} for more details.
|
||||
You can find it in \verb$samples/html/helpview$.
|
||||
You can find it in \tt{samples/html/helpview}.
|
||||
|
||||
\item[{\bf Tex2RTF}]
|
||||
Supplied with wxWindows is a utility called Tex2RTF for converting\rtfsp
|
||||
@ -530,7 +530,7 @@ Supplied with wxWindows is a utility called Tex2RTF for converting\rtfsp
|
||||
Help RTF formats. Tex2RTF is used for the wxWindows manuals and can be used independently
|
||||
by authors wishing to create on-line and printed manuals from the same\rtfsp
|
||||
\LaTeX\ source. Please see the separate documentation for Tex2RTF.
|
||||
You can find it under \verb$utils/tex2rtf$.
|
||||
You can find it under \tt{utils/tex2rtf}.
|
||||
|
||||
\item[{\bf Helpgen}]
|
||||
Helpgen takes C++ header files and generates a Tex2RTF-compatible
|
||||
@ -541,54 +541,54 @@ This is a good way to start a reference for a set of classes.
|
||||
Dialog Editor allows interactive construction of dialogs using
|
||||
absolute positioning, producing WXR output files. This tool is generally deprecated
|
||||
in favour of sizer-based tools. You can find Dialog Editor
|
||||
in \verb$utils/dialoged$.
|
||||
in \tt{utils/dialoged}.
|
||||
|
||||
\item[{\bf XRC resource system}]
|
||||
This is the sizer-aware replacement for the WXR resource system, and uses
|
||||
XML-based resource specifications that can be generated by tools
|
||||
such as \urlref{wxDesigner}{http://www.roebling.de} and XRC's own wxrcedit.
|
||||
You can find this in \verb$contrib/src/xrc$, \verb$contrib/include/wx/xrc$, \verb$contrib/samples/xrc$, and \verb$contrib/utils/wxrcedit$.
|
||||
You can find this in \tt{contrib/src/xrc}, \tt{contrib/include/wx/xrc}, \tt{contrib/samples/xrc}, and \tt{contrib/utils/wxrcedit}.
|
||||
For more information, see the \helpref{XML-based resource system overview}{xrcoverview}.
|
||||
|
||||
\item[{\bf Object Graphics Library}]
|
||||
OGL defines an API for applications that need to display objects connected by lines.
|
||||
The objects can be moved around and interacted with.
|
||||
You can find this in \verb$contrib/src/ogl$, \verb$contrib/include/wx/ogl$, and \verb$contrib/samples/ogl$.
|
||||
You can find this in \tt{contrib/src/ogl}, \tt{contrib/include/wx/ogl}, and \tt{contrib/samples/ogl}.
|
||||
|
||||
\item[{\bf Frame Layout library}]
|
||||
FL provides sophisticated pane dragging and docking facilities.
|
||||
You can find this in \verb$contrib/src/fl$, \verb$contrib/include/wx/fl$, and \verb$contrib/samples/fl$.
|
||||
You can find this in \tt{contrib/src/fl}, \tt{contrib/include/wx/fl}, and \tt{contrib/samples/fl}.
|
||||
|
||||
\item[{\bf Gizmos library}]
|
||||
Gizmos is a collection of useful widgets and other classes. Classes include wxLEDNumberCtrl,
|
||||
wxEditableListBox, wxMultiCellCanvas.
|
||||
You can find this in \verb$contrib/src/fl$, \verb$contrib/include/wx/fl$, and \verb$contrib/samples/fl$.
|
||||
You can find this in \tt{contrib/src/fl}, \tt{contrib/include/wx/fl}, and \tt{contrib/samples/fl}.
|
||||
|
||||
\item[{\bf Net library}]
|
||||
Net is a collection of very simple mail and web related classes. Currently
|
||||
there is only wxEmail, which makes it easy to send email messages via MAPI on Windows or sendmail on Unix.
|
||||
You can find this in \verb$contrib/src/net$ and \verb$contrib/include/wx/net$.
|
||||
You can find this in \tt{contrib/src/net} and \tt{contrib/include/wx/net}.
|
||||
|
||||
\item[{\bf Animate library}]
|
||||
Animate allows you to load animated GIFs and play them on a window. The library can be extended
|
||||
to use other animation formats.
|
||||
You can find this in \verb$contrib/src/animate$, \verb$contrib/include/wx/animate$, and \verb$contrib/samples/animate$.
|
||||
You can find this in \tt{contrib/src/animate}, \tt{contrib/include/wx/animate}, and \tt{contrib/samples/animate}.
|
||||
|
||||
\item[{\bf Canvas library}]
|
||||
Canvas supports high-level, double-buffered drawing operations with transformations.
|
||||
You can find this in \verb$contrib/src/canvas$, \verb$contrib/include/wx/canvas$, and \verb$contrib/samples/canvas$.
|
||||
You can find this in \tt{contrib/src/canvas}, \tt{contrib/include/wx/canvas}, and \tt{contrib/samples/canvas}.
|
||||
|
||||
\item[{\bf MMedia library}]
|
||||
Mmedia supports a variety of multimedia functionality. The status of this library is currently unclear.
|
||||
You can find this in \verb$contrib/src/mmedia$, \verb$contrib/include/wx/mmedia$, and \verb$contrib/samples/mmedia$.
|
||||
You can find this in \tt{contrib/src/mmedia}, \tt{contrib/include/wx/mmedia}, and \tt{contrib/samples/mmedia}.
|
||||
|
||||
\item[{\bf Styled Text Control library}]
|
||||
STC is a wrapper around Scintilla, a syntax-highlighting text editor.
|
||||
You can find this in \verb$contrib/src/stc$, \verb$contrib/include/wx/stc$, and \verb$contrib/samples/stc$.
|
||||
You can find this in \tt{contrib/src/stc}, \tt{contrib/include/wx/stc}, and \tt{contrib/samples/stc}.
|
||||
|
||||
\item[{\bf Plot}]
|
||||
Plot is a simple curve plotting library.
|
||||
You can find this in \verb$contrib/src/plot$, \verb$contrib/include/wx/plot$, and \verb$contrib/samples/plot$.
|
||||
You can find this in \tt{contrib/src/plot}, \tt{contrib/include/wx/plot}, and \tt{contrib/samples/plot}.
|
||||
\end{description}
|
||||
|
||||
\chapter{Programming strategies}\label{strategies}
|
||||
|
||||
@ -157,6 +157,7 @@
|
||||
\input htwinhnd.tex
|
||||
\input http.tex
|
||||
\input icon.tex
|
||||
\input iconbndl.tex
|
||||
\input iconevt.tex
|
||||
\input idleevt.tex
|
||||
\input image.tex
|
||||
|
||||
@ -289,6 +289,30 @@ propagate the notification to child windows and controls.
|
||||
|
||||
\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
|
||||
|
||||
\membersection{wxDialog::SetIcon}\label{wxdialogseticon}
|
||||
|
||||
\func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
|
||||
|
||||
Sets the icon for this dialog.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{icon}{The icon to associate with this dialog.}
|
||||
|
||||
See also \helpref{wxIcon}{wxicon}.
|
||||
|
||||
\membersection{wxDialog::SetIcons}\label{wxdialogseticons}
|
||||
|
||||
\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}
|
||||
|
||||
Sets the icons for this dialog.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{icons}{The icons to associate with this dialog.}
|
||||
|
||||
See also \helpref{wxIconBundle}{wxiconbundle}.
|
||||
|
||||
\membersection{wxDialog::SetModal}\label{wxdialogsetmodal}
|
||||
|
||||
\func{void}{SetModal}{\param{const bool}{ flag}}
|
||||
|
||||
@ -439,6 +439,20 @@ The frame takes a `copy' of {\it icon}, but since it uses reference
|
||||
counting, the copy is very quick. It is safe to delete {\it icon} after
|
||||
calling this function.
|
||||
|
||||
See also \helpref{wxIcon}{wxicon}.
|
||||
|
||||
\membersection{wxFrame::SetIcons}\label{wxframeseticons}
|
||||
|
||||
\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}
|
||||
|
||||
Sets the icons for this frame.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{icons}{The icons to associate with this frame.}
|
||||
|
||||
See also \helpref{wxIconBundle}{wxiconbundle}.
|
||||
|
||||
% VZ: we don't have all this any more (18.08.00)
|
||||
%
|
||||
%Under Windows, instead of using {\bf SetIcon}, you can add the
|
||||
@ -466,8 +480,6 @@ calling this function.
|
||||
%You can replace std.ico, mdi.ico and child.ico with your own defaults
|
||||
%for all your wxWindows application. Currently they show the same icon.
|
||||
|
||||
See also \helpref{wxIcon}{wxicon}.
|
||||
|
||||
\membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
|
||||
|
||||
\func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}}
|
||||
|
||||
67
docs/latex/wx/iconbndl.tex
Normal file
67
docs/latex/wx/iconbndl.tex
Normal file
@ -0,0 +1,67 @@
|
||||
\section{\class{wxIconBundle}}\label{wxiconbundle}
|
||||
|
||||
This class contains multiple copies of an icon in different sizes,
|
||||
see also \helpref{wxDialog::SetIcons}{wxdialogseticons} and
|
||||
\helpref{wxFrame::SetIcons}{wxframeseticons}.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
No base class
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxIconBundle::wxIconBundle}\label{wxiconbundlewxiconbundle}
|
||||
|
||||
\func{}{wxIconBundle}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
\func{}{wxIconBundle}{\param{const wxString\& }{file}, \param{long }{type}}
|
||||
|
||||
Initializes the bundle with the icon(s) found in the file.
|
||||
|
||||
\func{}{wxIconBundle}{\param{const wxIcon\& }{icon}}
|
||||
|
||||
Initializes the bundle with a single icon.
|
||||
|
||||
\func{}{wxIconBundle}{\param{const wxIconBundle\& }{ic}}
|
||||
|
||||
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}}
|
||||
|
||||
Adds all the icons contained in the file to the bundle;
|
||||
if the collection already contains icons with the same
|
||||
width and height, they are replaced by the new ones.
|
||||
|
||||
\func{void}{AddIcon}{\param{const wxIcon\& }{icon}}
|
||||
|
||||
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}}
|
||||
|
||||
Returns the icon with the given size; if no such icon exists,
|
||||
returns the icon with size wxSYS\_ICON\_X/wxSYS\_ICON\_Y;
|
||||
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}}
|
||||
|
||||
Same as GetIcon( wxSize( size, size ) ).
|
||||
|
||||
\membersection{wxIconBundle::operator=}\label{wxiconbundleoperatorassign}
|
||||
|
||||
\func{const wxIconBundle\&}{operator=}{\param{const wxIconBundle\& }{ic}}
|
||||
@ -126,7 +126,7 @@ Returns flags, which may be a bitlist of wxXRC\_USE\_LOCALE and wxXRC\_NO\_SUBCL
|
||||
|
||||
\constfunc{long}{GetVersion}{\void}
|
||||
|
||||
Returns version information (a.b.c.d = d+ 256*c + 256\verb|^|2*b + 256\verb|^|3*a).
|
||||
Returns version information (a.b.c.d = d+ 256*c + 256\tt{^}2*b + 256\tt{^}3*a).
|
||||
|
||||
\membersection{wxXmlResource::GetXRCID}\label{wxxmlresourcegetxmlid}
|
||||
|
||||
|
||||
@ -196,7 +196,7 @@ Gets text from param and does some conversions:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item replaces $\backslash$n, $\backslash$r, $\backslash$t by respective characters (according to C syntax)
|
||||
\item replaces \verb+$+ by \verb+\&+ and \verb+\$\$+ by \verb+\$+ (needed for \verb+_File+ to \verb+\&File+
|
||||
\item replaces \tt{\$} by \tt{\&} and \tt{\$\$} by \tt{\$} (needed for \tt{\_File} to \tt{\&File}
|
||||
translation because of XML syntax)
|
||||
\item calls wxGetTranslations (unless disabled in wxXmlResource)
|
||||
\end{itemize}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user