]> git.saurik.com Git - wxWidgets.git/blame - contrib/docs/latex/deprecated/propfovi.tex
test undividable words
[wxWidgets.git] / contrib / docs / latex / deprecated / propfovi.tex
CommitLineData
82e20720
JS
1\section{\class{wxPropertyFormView}}\label{wxpropertyformview}
2
3The {\bf wxPropertyFormView} class shows a wxPropertySheet as a view onto a panel or dialog
4box which has already been created.
5
6\wxheading{See also}
7
8\helpref{wxPropertyFormView overview}{wxpropertyformviewoverview}
9
10\latexignore{\rtfignore{\wxheading{Members}}}
11
12\membersection{wxPropertyFormView::wxPropertyFormView}
13
14\func{void}{wxPropertyFormView}{\param{long}{ flags = 0}}
15
16Constructor.
17
18\membersection{wxPropertyFormView::\destruct{wxPropertyFormView}}
19
20\func{void}{\destruct{wxPropertyFormView}}{\void}
21
22Destructor.
23
24\membersection{wxPropertyFormView::AssociateNames}\label{wxpropertyformviewassociatenames}
25
26\func{void}{AssociateNames}{\void}
27
28Associates the properties with the controls on the panel. For each panel item, if the
29panel item name is the same as a property name, the two objects will be associated.
30This function should be called manually since the programmer may wish to do the
31association manually.
32
33\membersection{wxPropertyFormView::Check}\label{wxpropertyformviewcheck}
34
35\func{bool}{Check}{\void}
36
37Checks all properties by calling the appropriate validators; returns false if a validation failed.
38
39\membersection{wxPropertyFormView::GetPanel}\label{wxpropertyformviewgetpanel}
40
41\func{wxPanel *}{GetPanel}{\void}
42
43Returns the panel associated with the view.
44
45\membersection{wxPropertyFormView::GetManagedWindow}\label{wxpropertyformviewgetmanagedwindow}
46
47\func{wxWindow *}{GetManagedWindow}{\void}
48
49Returns the managed window (a frame or dialog) associated with the view.
50
51\membersection{wxPropertyFormView::OnOk}\label{wxpropertyformviewonok}
52
53\func{void}{OnOk}{\void}
54
55Virtual function that will be called when the OK button on the physical window is pressed.
56By default, checks and updates the form values, closes and deletes the frame or dialog, then deletes the view.
57
58\membersection{wxPropertyFormView::OnCancel}\label{wxpropertyformviewoncancel}
59
60\func{void}{OnCancel}{\void}
61
62Virtual function that will be called when the Cancel button on the physical window is pressed.
63By default, closes and deletes the frame or dialog, then deletes the view.
64
65\membersection{wxPropertyFormView::OnHelp}\label{wxpropertyformviewonhelp}
66
67\func{void}{OnHelp}{\void}
68
69Virtual function that will be called when the Help button on the physical window is pressed.
70This needs to be overridden by the application for anything interesting to happen.
71
72\membersection{wxPropertyFormView::OnRevert}\label{wxpropertyformviewonrevert}
73
74\func{void}{OnRevert}{\void}
75
76Virtual function that will be called when the Revert button on the physical window is pressed.
77By default transfers the wxProperty values to the panel items (in effect
78undoing any unsaved changes in the items).
79
80\membersection{wxPropertyFormView::OnUpdate}\label{wxpropertyformviewonupdate}
81
82\func{void}{OnUpdate}{\void}
83
84Virtual function that will be called when the Update button on the physical window is pressed.
85By defaults transfers the displayed values to the wxProperty objects.
86
87\membersection{wxPropertyFormView::SetManagedWindow}\label{wxpropertyformviewsetmanagedwindow}
88
89\func{void}{SetManagedWindow}{\param{wxWindow *}{win}}
90
91Sets the managed window (a frame or dialog) associated with the view.
92
93\membersection{wxPropertyFormView::TransferToDialog}\label{wxpropertyformviewtransfertodialog}
94
95\func{bool}{TransferToDialog}{\void}
96
97Transfers property values to the controls in the dialog.
98
99\membersection{wxPropertyFormView::TransferToPropertySheet}\label{wxpropertyformviewtransfertopropertysheet}
100
101\func{bool}{TransferToPropertySheet}{\void}
102
103Transfers property values from the controls in the dialog to the property sheet.
104