docs/latex/wx/proplstv.tex

   1 \section{\class{wxPropertyListView}}\label{wxpropertylistview}
   2
   3 The {\bf wxPropertyListView} class shows a wxPropertySheet as a Visual Basic-style property list.
   4
   5 \wxheading{See also}
   6
   7 \helpref{wxPropertyListView overview}{wxpropertylistviewoverview}
   8
   9 \latexignore{\rtfignore{\wxheading{Members}}}
  10
  11 \membersection{wxPropertyListView::wxPropertyListView}
  12
  13 \func{void}{wxPropertyListView}{ \param{wxPanel*} propPanel = NULL, \param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
  14
  15 Constructor.
  16
  17 The {\it flags} argument can be a bit list of the following:
  18
  19 \begin{itemize}\itemsep=0pt
  20 \item wxPROP\_BUTTON\_CLOSE
  21 \item wxPROP\_BUTTON\_OK
  22 \item wxPROP\_BUTTON\_CANCEL
  23 \item wxPROP\_BUTTON\_CHECK\_CROSS
  24 \item wxPROP\_BUTTON\_HELP
  25 \item wxPROP\_DYNAMIC\_VALUE\_FIELD
  26 \item wxPROP\_PULLDOWN
  27 \end{itemize}
  28
  29 \membersection{wxPropertyListView::\destruct{wxPropertyListView}}
  30
  31 \func{void}{\destruct{wxPropertyListView}}{\void}
  32
  33 Destructor.
  34
  35 \membersection{wxPropertyListView::AssociatePanel}\label{wxpropertylistviewassociatepanel}
  36
  37 \func{void}{AssociatePanel}{\param{wxPanel *}{panel}}
  38
  39 Associates the window on which the controls will be displayed, with the view (sets an internal pointer to the window).
  40
  41 \membersection{wxPropertyListView::BeginShowingProperty}\label{wxpropertylistviewbeginshowingproperty}
  42
  43 \func{bool}{BeginShowingProperty}{\param{wxProperty *}{property}}
  44
  45 Finds the appropriate validator and loads the property into the controls, by calling
  46 wxPropertyValidator::OnPrepareControls and then wxPropertyListView::DisplayProperty.
  47
  48 \membersection{wxPropertyListView::DisplayProperty}\label{wxpropertylistviewdisplayproperty}
  49
  50 \func{bool}{DisplayProperty}{\param{wxProperty *}{property}}
  51
  52 Calls wxPropertyValidator::OnDisplayValue for the current property's validator. This function
  53 gets called by wxPropertyListView::BeginShowingProperty, which is in turn called
  54 from ShowProperty, called by OnPropertySelect, called by the listbox callback when selected.
  55
  56 \membersection{wxPropertyListView::EndShowingProperty}\label{wxpropertylistviewendshowingproperty}
  57
  58 \func{bool}{EndShowingProperty}{\param{wxProperty *}{property}}
  59
  60 Finds the appropriate validator and unloads the property from the controls, by calling
  61 wxPropertyListView::RetrieveProperty, wxPropertyValidator::OnClearControls and (if we're in
  62 detailed editing mdoe) wxPropertyValidator::OnClearDetailControls.
  63
  64 \membersection{wxPropertyListView::GetPanel}\label{wxpropertylistviewgetpanel}
  65
  66 \func{wxPanel *}{GetPanel}{\void}
  67
  68 Returns the panel associated with the view.
  69
  70 \membersection{wxPropertyListView::GetManagedWindow}\label{wxpropertylistviewgetmanagedwindow}
  71
  72 \func{wxWindow *}{GetManagedWindow}{\void}
  73
  74 Returns the managed window (a frame or dialog) associated with the view.
  75
  76 \membersection{wxPropertyListView::GetWindowCancelButton}\label{wxpropertylistviewgetwindowcancelbutton}
  77
  78 \func{wxButton *}{GetWindowCancelButton}{\void}
  79
  80 Returns the window cancel button, if any.
  81
  82 \membersection{wxPropertyListView::GetWindowCloseButton}\label{wxpropertylistviewgetwindowclosebutton}
  83
  84 \func{wxButton *}{GetWindowCloseButton}{\void}
  85
  86 Returns the window close or OK button, if any.
  87
  88 \membersection{wxPropertyListView::GetWindowHelpButton}\label{wxpropertylistviewgetwindowhelpbutton}
  89
  90 \func{wxButton *}{GetWindowHelpButton}{\void}
  91
  92 Returns the window help button, if any.
  93
  94 \membersection{wxPropertyListView::SetManagedWindow}\label{wxpropertylistviewsetmanagedwindow}
  95
  96 \func{void}{SetManagedWindow}{\param{wxWindow *}{win}}
  97
  98 Sets the managed window (a frame or dialog) associated with the view.
  99
 100 \membersection{wxPropertyListView::UpdatePropertyDisplayInList}\label{wxpropertylistviewupdatepropdisplay}
 101
 102 \func{bool}{UpdatePropertyDisplayInList}{\param{wxProperty *}{property}}
 103
 104 Updates the display for the given changed property.
 105
 106 \membersection{wxPropertyListView::UpdatePropertyList}\label{wxpropertylistviewupdateproplist}
 107
 108 \func{bool}{UpdatePropertyList}{\param{bool }{clearEditArea = TRUE}}
 109
 110 Updates the whole property list display.
 111