]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/tsamples.tex
Some doc changes
[wxWidgets.git] / docs / latex / wx / tsamples.tex
CommitLineData
eb91c0be
VZ
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: tsamples.tex
3%% Purpose: Samples description
4%% Author: Vadim Zeitlin
5%% Modified by:
6%% Created: 02.11.99
7%% RCS-ID: $Id$
8%% Copyright: (c) wxWindows team
9%% Licence: wxWindows licence
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{wxWindows samples}\label{samples}
13
14Probably the best way to learn wxWindows is by reading the source of some 50+
15samples provided with it. Many aspects of wxWindows programming can be learnt
16from them, but sometimes it is not simple to just choose the right sample to
17look at. This overview aims at describing what each sample does/demonstrates to
18make it easier to find the relevant one if a simple grep through all sources
19didn't help. They also provide some notes about using the samples and what
20features of wxWindows are they supposed to test.
21
775a998e
VZ
22\subsection{Font sample}\label{samplefont}
23
24The font sample demonstrates \helpref{wxFont}{wxfont},
25\helpref{wxFontEnumerator}{wxfontenumerator} and
26\helpref{wxFontMapper}{wxfontmapper} classes. It allows you to see the fonts
27available (to wxWindows) on the computer and shows all characters of the
28chosen font as well.
29
c03648c2 30\subsection{DnD sample}\label{samplednd}
eb91c0be
VZ
31
32This sample shows both clipboard and drag and drop in action. It is quite non
33trivial and may be safely used as a basis for implementing the clipboard and
34drag and drop operations in a real-life program.
35
36When you run the sample, its screen is split in several parts. On the top,
37there are two listboxes which show the standard derivations of
38\helpref{wxDropTarget}{wxdroptarget}:
39\helpref{wxTextDropTarget}{wxtextdroptarget} and
40\helpref{wxFileDropTarget}{wxfiledroptarget}.
41
42The middle of the sample window is taken by the log window which shows what is
43going on (of course, this only works in debug builds) and may be helpful to see
44the sequence of steps of data transfer.
45
46Finally, the last part is used for two things: you can drag text from it to
47either one of the listboxes (only one will accept it) or another application
48and, also, bitmap pasted from clipboard will be shown there.
49
50So far, everything we mentioned was implemented with minimal amount of code
51using standard wxWindows classes. The more advanced features are demonstrated
52if you create a shape frame from the main frame menu. A shape is a geometric
53object which has a position, size and color. It models some
54application-specific data in this sample. A shape object supports its own
55private \helpref{wxDataFormat}{wxdataformat} which means that you may cut and
56paste it or drag and drop (between one and the same or different shapes) from
57one sample instance to another (or the same). However, chances are that no
58other program supports this format and so shapes can also be rendered as
59bitmaps which allows them to be pasted/dropped in many other applications.
60
61Take a look at DnDShapeDataObject class to see how you may use
62\helpref{wxDataObject}{wxdataobject} to achieve this.