]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/doxygen/overviews/roughguide.h
Documentation screenshot generator source code cleanup.
[wxWidgets.git] / docs / doxygen / overviews / roughguide.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: roughguide.h
3// Purpose: topic overview
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows licence
7/////////////////////////////////////////////////////////////////////////////
8
9/**
10
11@page overview_roughguide A Quick Guide to Writing Applications
12
13To set a wxWidgets application going, you will need to derive a wxApp class and
14override wxApp::OnInit.
15
16An application must have a top-level wxFrame or wxDialog window. Each frame may
17contain one or more instances of classes such as wxPanel, wxSplitterWindow or
18other windows and controls.
19
20A frame can have a wxMenuBar, a wxToolBar, a wxStatusBar, and a wxIcon for when
21the frame is iconized.
22
23A wxPanel is used to place controls (classes derived from wxControl) which are
24used for user interaction. Examples of controls are wxButton, wxCheckBox,
25wxChoice, wxListBox, wxRadioBox, and wxSlider.
26
27Instances of wxDialog can also be used for controls and they have the advantage
28of not requiring a separate frame.
29
30Instead of creating a dialog box and populating it with items, it is possible
31to choose one of the convenient common dialog classes, such as wxMessageDialog
32and wxFileDialog.
33
34You never draw directly onto a window - you use a <em>device context</em> (DC).
35wxDC is the base for wxClientDC, wxPaintDC, wxMemoryDC, wxPostScriptDC,
36wxMemoryDC, wxMetafileDC and wxPrinterDC. If your drawing functions have wxDC
37as a parameter, you can pass any of these DCs to the function, and thus use the
38same code to draw to several different devices. You can draw using the member
39functions of wxDC, such as wxDC::DrawLine and wxDC::DrawText. Control colour on
40a window (wxColour) with brushes (wxBrush) and pens (wxPen).
41
42To intercept events, you add a DECLARE_EVENT_TABLE macro to the window class
43declaration, and put a BEGIN_EVENT_TABLE ... END_EVENT_TABLE block in the
44implementation file. Between these macros, you add event macros which map the
45event (such as a mouse click) to a member function. These might override
46predefined event handlers such as for wxKeyEvent and wxMouseEvent.
47
48Most modern applications will have an on-line, hypertext help system; for this,
49you need wxHelp and the wxHelpController class to control wxHelp.
50
51GUI applications aren't all graphical wizardry. List and hash table needs are
52catered for by wxList and wxHashMap. You will undoubtedly need some
53platform-independent @ref group_funcmacro_file, and you may find it handy to
54maintain and search a list of paths using wxPathList. There's many
55@ref group_funcmacro_misc of operating system methods and other functions.
56
57@see
58
59@li @ref group_class
60
61*/
62