]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/propview.tex
added container class source
[wxWidgets.git] / docs / latex / wx / propview.tex
... / ...
CommitLineData
1\section{\class{wxPropertyView}}\label{wxpropertyview}
2
3The {\bf wxPropertyView} abstract class is the base class for views
4of property sheets, acting as intermediaries between properties and
5actual windows.
6
7\wxheading{See also}
8
9\helpref{wxPropertyView overview}{wxpropertyviewoverview}
10
11\latexignore{\rtfignore{\wxheading{Members}}}
12
13\membersection{wxPropertyView::wxPropertyView}
14
15\func{void}{wxPropertyView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
16
17Constructor.
18
19The {\it flags} argument can be a bit list of the following:
20
21\begin{itemize}\itemsep=0pt
22\item wxPROP\_BUTTON\_CLOSE
23\item wxPROP\_BUTTON\_OK
24\item wxPROP\_BUTTON\_CANCEL
25\item wxPROP\_BUTTON\_CHECK\_CROSS
26\item wxPROP\_BUTTON\_HELP
27\item wxPROP\_DYNAMIC\_VALUE\_FIELD
28\item wxPROP\_PULLDOWN
29\end{itemize}
30
31\membersection{wxPropertyView::\destruct{wxPropertyView}}
32
33\func{void}{\destruct{wxPropertyView}}{\void}
34
35Destructor.
36
37\membersection{wxPropertyView::AddRegistry}\label{wxpropertyviewaddregistry}
38
39\func{void}{AddRegistry}{\param{wxPropertyValidatorRegistry *}{registry}}
40
41Adds a registry (list of property validators) the view's list of registries, which is initially empty.
42
43\membersection{wxPropertyView::FindPropertyValidator}\label{wxpropertyviewfindpropertyvalidator}
44
45\func{wxPropertyValidator *}{FindPropertyValidator}{\param{wxProperty *}{property}}
46
47Finds the property validator that is most appropriate to this property.
48
49\membersection{wxPropertyView::GetPropertySheet}\label{wxpropertyviewgetpropertysheet}
50
51\func{wxPropertySheet *}{GetPropertySheet}{\void}
52
53Gets the property sheet for this view.
54
55\membersection{wxPropertyView::GetRegistryList}\label{wxpropertyviewgetregistrylist}
56
57\func{wxList\&}{GetRegistryList}{\void}
58
59Returns a reference to the list of property validator registries.
60
61\membersection{wxPropertyView::OnOk}\label{wxpropertyviewonok}
62
63\func{void}{OnOk}{\void}
64
65Virtual function that will be called when the OK button on the physical window is pressed (if it exists).
66
67\membersection{wxPropertyView::OnCancel}\label{wxpropertyviewoncancel}
68
69\func{void}{OnCancel}{\void}
70
71Virtual function that will be called when the Cancel button on the physical window is pressed (if it exists).
72
73\membersection{wxPropertyView::OnClose}\label{wxpropertyviewonclose}
74
75\func{bool}{OnClose}{\void}
76
77Virtual function that will be called when the physical window is closed. The default implementation returns FALSE.
78
79\membersection{wxPropertyView::OnHelp}\label{wxpropertyviewonhelp}
80
81\func{void}{OnHelp}{\void}
82
83Virtual function that will be called when the Help button on the physical window is pressed (if it exists).
84
85\membersection{wxPropertyView::OnPropertyChanged}\label{wxpropertyviewonpropertychanged}
86
87\func{void}{OnPropertyChanged}{\param{wxProperty *}{property}}
88
89Virtual function called by a view or validator when a property's value changed. Validators
90must be written correctly for this to be called. You can override this function
91to respond immediately to property value changes.
92
93\membersection{wxPropertyView::OnUpdateView}\label{wxpropertyviewonupdateview}
94
95\func{bool}{OnUpdateView}{\void}
96
97Called by the viewed object to update the view. The default implementation just returns
98FALSE.
99
100\membersection{wxPropertyView::SetPropertySheet}\label{wxpropertyviewsetpropertysheet}
101
102\func{void}{SetPropertySheet}{\param{wxPropertySheet *}{sheet}}
103
104Sets the property sheet for this view.
105
106\membersection{wxPropertyView::ShowView}\label{wxpropertyviewshowview}
107
108\func{void}{ShowView}{\param{wxPropertySheet *}{sheet}, \param{wxPanel *}{panel}}
109
110Associates this view with the given panel, and shows the view.
111