File: cbbarhintsplugin.tex

package info (click to toggle)
wxwidgets2.8 2.8.10.1-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 239,052 kB
  • ctags: 289,550
  • sloc: cpp: 1,838,857; xml: 396,717; python: 282,506; ansic: 126,171; makefile: 51,406; sh: 14,581; asm: 299; sql: 258; lex: 194; perl: 139; yacc: 128; pascal: 95; php: 39; lisp: 38; tcl: 24; haskell: 20; java: 18; cs: 18; erlang: 17; ruby: 16; ada: 9; ml: 9; csh: 9
file content (155 lines) | stat: -rw-r--r-- 4,274 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
%
% automatically generated by HelpGen $Revision: 13938 $ from
% barhintspl.h at 21/Jan/02 21:14:18
%


\section{\class{cbBarHintsPlugin}}\label{cbbarhintsplugin}


This class intercepts bar-decoration and sizing events, and draws 3D hints
around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x

\wxheading{Derived from}

\helpref{cbPluginBase}{cbpluginbase}

\wxheading{Include files}

<wx/fl/barhintspl.h>

\wxheading{Data structures}

\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{cbBarHintsPlugin::cbBarHintsPlugin}\label{cbbarhintsplugincbbarhintsplugin}

\func{}{cbBarHintsPlugin}{\void}

Default constructor.


\func{}{cbBarHintsPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}

Constructor, taking parent frame and pane mask flag.


\membersection{cbBarHintsPlugin::\destruct{cbBarHintsPlugin}}\label{cbbarhintsplugindtor}

\func{}{\destruct{cbBarHintsPlugin}}{\void}

Destructor.


\membersection{cbBarHintsPlugin::CreateBoxes}\label{cbbarhintsplugincreateboxes}

\func{void}{CreateBoxes}{\void}

Helper function: creates close and collapse boxes.


\membersection{cbBarHintsPlugin::DoDrawHint}\label{cbbarhintsplugindodrawhint}

\func{void}{DoDrawHint}{\param{wxDC\& }{dc}, \param{wxRect\& }{rect}, \param{int }{pos}, \param{int }{boxOfs}, \param{int }{grooveOfs}, \param{bool }{isFixed}}

Helper function: draws a hint.


\membersection{cbBarHintsPlugin::Draw3DBox}\label{cbbarhintsplugindraw3dbox}

\func{void}{Draw3DBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}

Helper function: draws a 3D box.


\membersection{cbBarHintsPlugin::DrawCloseBox}\label{cbbarhintsplugindrawclosebox}

\func{void}{DrawCloseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}

Helper function: draws a close box.


\membersection{cbBarHintsPlugin::DrawCollapseBox}\label{cbbarhintsplugindrawcollapsebox}

\func{void}{DrawCollapseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{atLeft}, \param{bool }{disabled}, \param{bool }{pressed}}

Helper function: draws a collapse box.


\membersection{cbBarHintsPlugin::DrawGrooves}\label{cbbarhintsplugindrawgrooves}

\func{void}{DrawGrooves}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{int }{length}}

Helper function: draws grooves.


\membersection{cbBarHintsPlugin::ExcludeHints}\label{cbbarhintspluginexcludehints}

\func{void}{ExcludeHints}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}}

Helper function.


\membersection{cbBarHintsPlugin::GetHintsLayout}\label{cbbarhintsplugingethintslayout}

\func{void}{GetHintsLayout}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}, \param{int\& }{boxOfs}, \param{int\& }{grooveOfs}, \param{int\& }{pos}}

Helper function: gets the layout of a hint.


\membersection{cbBarHintsPlugin::HitTestHints}\label{cbbarhintspluginhittesthints}

\func{int}{HitTestHints}{\param{cbBarInfo\& }{info}, \param{const wxPoint\& }{pos}}

Helper function: returns information about the hint under the given position.


\membersection{cbBarHintsPlugin::OnDrawBarDecorations}\label{cbbarhintspluginondrawbardecorations}

\func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}

Handles a plugin event.


\membersection{cbBarHintsPlugin::OnInitPlugin}\label{cbbarhintspluginoninitplugin}

\func{void}{OnInitPlugin}{\void}

Called to initialize this plugin.


\membersection{cbBarHintsPlugin::OnLeftDown}\label{cbbarhintspluginonleftdown}

\func{void}{OnLeftDown}{\param{cbLeftDownEvent\& }{event}}

Handles a plugin event.


\membersection{cbBarHintsPlugin::OnLeftUp}\label{cbbarhintspluginonleftup}

\func{void}{OnLeftUp}{\param{cbLeftUpEvent\& }{event}}

Handles a plugin event.


\membersection{cbBarHintsPlugin::OnMotion}\label{cbbarhintspluginonmotion}

\func{void}{OnMotion}{\param{cbMotionEvent\& }{event}}

Handles a plugin event.


\membersection{cbBarHintsPlugin::OnSizeBarWindow}\label{cbbarhintspluginonsizebarwindow}

\func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}

Handles a plugin event.


\membersection{cbBarHintsPlugin::SetGrooveCount}\label{cbbarhintspluginsetgroovecount}

\func{void}{SetGrooveCount}{\param{int }{nGrooves}}

Set the number of grooves to be shown in the pane.