]>
Commit | Line | Data |
---|---|---|
499b2ed8 JS |
1 | \chapter{Classes by category}\label{classesbycat} |
2 | \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% | |
3 | \setfooter{\thepage}{}{}{}{}{\thepage}% | |
4 | ||
5 | A classification of FL classes by category. | |
499b2ed8 | 6 | |
4cbc57f0 | 7 | {\large {\bf Plugin classes}} |
499b2ed8 | 8 | |
4cbc57f0 | 9 | Plugins can be added to frame layouts to extend behaviour. |
499b2ed8 | 10 | |
4cbc57f0 JS |
11 | \twocolwidtha{6cm} |
12 | \begin{twocollist}\itemsep=0pt | |
13 | \twocolitem{\helpref{cbAntiflickerPlugin}{cbantiflickerplugin}}{Double-buffering class} | |
14 | \twocolitem{\helpref{cbBarDragPlugin}{cbbardragplugin}}{Implements drag behaviour.} | |
15 | \twocolitem{\helpref{cbBarHintsPlugin}{cbbarhintsplugin}}{Implements bar decoration and sizing behaviour.} | |
16 | \twocolitem{\helpref{cbHintAnimationPlugin}{cbhintanimationplugin}}{Draws animated hints when the user drags a pane.} | |
17 | \twocolitem{\helpref{cbPaneDrawPlugin}{cbpanedrawplugin}}{Implements most of MFC-style control bar implementation.} | |
18 | \twocolitem{\helpref{cbPluginBase}{cbpluginbase}}{Abstract base class for all control-bar related plugins.} | |
19 | \twocolitem{\helpref{cbRowDragPlugin}{cbrowdragplugin}}{Implements row-dragging functionality.} | |
20 | \twocolitem{\helpref{cbRowLayoutPlugin}{cbrowlayoutplugin}}{Implements row layout functionality.} | |
21 | \twocolitem{\helpref{cbSimpleCustomizationPlugin}{cbsimplecustomizationplugin}}{Enables customization of a bar.} | |
22 | \twocolitem{\helpref{cbBarSpy}{cbbarspy}}{Helper class used for spying for unhandled mouse events on control bars and forwarding them to the frame layout.} | |
23 | \end{twocollist} | |
24 | ||
25 | {\large {\bf Window classes}} | |
26 | ||
27 | Windows classes (note that the mini-button implementations are not true windows | |
28 | in that they do not derive from wxWindow). | |
29 | ||
30 | \twocolwidtha{6cm} | |
31 | \begin{twocollist}\itemsep=0pt | |
32 | \twocolitem{\helpref{wxToolWindow}{wxtoolwindow}}{A small frame that paints its own titlebar.} | |
33 | \twocolitem{\helpref{cbFloatedBarWindow}{cbfloatedbarwindow}}{A kind of wxToolWindow implementing floating windows.} | |
34 | \twocolitem{\helpref{cbMiniButton}{cbminibutton}}{Base class for wxToolWindow titlebar buttons.} | |
35 | \twocolitem{\helpref{cbCloseBox}{cbclosebox}}{Close button for wxToolWindow titlebar.} | |
36 | \twocolitem{\helpref{cbCollapseBox}{cbcollapsebox}}{Collapse button for wxToolWindow titlebar.} | |
37 | \twocolitem{\helpref{cbDockBox}{cbdockbox}}{Dock button for wxToolWindow titlebar.} | |
38 | \twocolitem{\helpref{cbCloseBox}{cbclosebox}}{Close button for wxToolWindow titlebar.} | |
39 | \twocolitem{\helpref{wxNewBitmapButton}{wxnewbitmapbutton}}{Alternative bitmap button class.} | |
40 | \end{twocollist} | |
41 | ||
42 | {\large {\bf Layout management classes}} | |
43 | ||
44 | These classes relate to the layout management framework. | |
45 | ||
46 | \twocolwidtha{6cm} | |
47 | \begin{twocollist}\itemsep=0pt | |
48 | \twocolitem{\helpref{cbDockPane}{cbdockpane}}{Manages containment and control of bars in a prent frame.} | |
49 | \twocolitem{\helpref{BagLayout}{baglayout}}{BagLayout lays out items in left-to-right order from top to bottom.} | |
50 | \twocolitem{\helpref{cbUpdatesManagerBase}{cbupdatesmanagerbase}}{An abstract interface for display update optimization logic.} | |
51 | \twocolitem{\helpref{cbSimpleUpdatesMgr}{cbsimpleupdatesmgr}}{Implements optimized logic for refreshing areas of frame layout that need to be updated.} | |
52 | \twocolitem{\helpref{cbGCUpdatesMgr}{cbgcupdatesmgr}}{Implements optimized logic for refresh, based on a garbage collection algorithm.} | |
53 | \twocolitem{\helpref{GarbageCollector}{garbagecollector}}{A garbage collection algorithm for use in display refresh optimization.} | |
54 | \twocolitem{\helpref{wxFrameLayout}{wxframelayout}}{Manages containment and docking of control bars, which can be docked along the top, bottom, right, or left side of the parent frame.} | |
55 | \end{twocollist} | |
56 | ||
57 | {\large {\bf Event classes}} | |
499b2ed8 | 58 | |
90b5abc1 JS |
59 | Events are used to decouple parts of the layout framework. For event macros and identifiers, |
60 | please see the topic \helpref{Event macros and identifiers}{events}. | |
499b2ed8 | 61 | |
4cbc57f0 | 62 | \twocolwidtha{6cm} |
499b2ed8 | 63 | \begin{twocollist}\itemsep=0pt |
4cbc57f0 JS |
64 | \twocolitem{\helpref{cbCustomizeBarEvent}{cbcustomizebarevent}}{Class for bar customization events.} |
65 | \twocolitem{\helpref{cbCustomizeLayoutEvent}{cbcustomizelayoutevent}}{Class for layout customization events.} | |
66 | \twocolitem{\helpref{cbDrawBarDecorEvent}{cbdrawbardecorevent}}{Class for bar decoration drawing events.} | |
67 | \twocolitem{\helpref{cbDrawBarHandlesEvent}{cbdrawbarhandlesevent}}{Class for bar handles drawing events.} | |
68 | \twocolitem{\helpref{cbDrawHintRectEvent}{cbdrawhintrectevent}}{Class for hint-rectangle drawing events.} | |
69 | \twocolitem{\helpref{cbDrawPaneBkGroundEvent}{cbdrawpanebkgroundevent}}{Class for pane background drawing events.} | |
70 | \twocolitem{\helpref{cbDrawPaneDecorEvent}{cbdrawpanedecorevent}}{Class for pane decoration drawing events.} | |
71 | \twocolitem{\helpref{cbDrawRowBkGroundEvent}{cbdrawrowbkgroundevent}}{Class for row background drawing events.} | |
72 | \twocolitem{\helpref{cbDrawRowDecorEvent}{cbdrawrowdecorevent}}{Class for row decoration drawing events.} | |
73 | \twocolitem{\helpref{cbDrawRowHandlesEvent}{cbdrawrowhandlesevent}}{Class for row handles drawing events.} | |
74 | \twocolitem{\helpref{cbFinishDrawInAreaEvent}{cbfinishdrawinareaevent}}{Class for finish drawing in area events.} | |
75 | \twocolitem{\helpref{cbInsertBarEvent}{cbinsertbarevent}}{Class for bar insertion events.} | |
76 | \twocolitem{\helpref{cbLayoutRowEvent}{cblayoutrowevent}}{Class for single row layout events.} | |
77 | \twocolitem{\helpref{cbLayoutRowsEvent}{cblayoutrowsevent}}{Class for multiple rows layout events.} | |
78 | \twocolitem{\helpref{cbLeftDClickEvent}{cbleftdclickevent}}{Class for mouse left double click events.} | |
79 | \twocolitem{\helpref{cbLeftDownEvent}{cbleftdownevent}}{Class for mouse left down events.} | |
80 | \twocolitem{\helpref{cbLeftUpEvent}{cbleftupevent}}{Class for mouse left up events.} | |
81 | \twocolitem{\helpref{cbMotionEvent}{cbmotionevent}}{Class for mouse motion events.} | |
82 | \twocolitem{\helpref{cbPluginEvent}{cbpluginevent}}{Base class for all control-bar plugin events.} | |
83 | \twocolitem{\helpref{cbRemoveBarEvent}{cbremovebarevent}}{Class for bar removal events.} | |
84 | \twocolitem{\helpref{cbResizeBarEvent}{cbresizebarevent}}{Class for bar resize events.} | |
85 | \twocolitem{\helpref{cbResizeRowEvent}{cbresizerowevent}}{Class for row resize events.} | |
86 | \twocolitem{\helpref{cbRightDownEvent}{cbrightdownevent}}{Class for mouse right down events.} | |
87 | \twocolitem{\helpref{cbRightUpEvent}{cbrightupevent}}{Class for mouse right up events.} | |
88 | \twocolitem{\helpref{cbSizeBarWndEvent}{cbsizebarwndevent}}{Class for bar window resize events.} | |
89 | \twocolitem{\helpref{cbStartBarDraggingEvent}{cbstartbardraggingevent}}{Class for start-bar-dragging events.} | |
90 | \twocolitem{\helpref{cbStartDrawInAreaEvent}{cbstartdrawinareaevent}}{Class for start drawing in area events.} | |
499b2ed8 | 91 | \end{twocollist} |
499b2ed8 | 92 |