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