mirror of
https://github.com/wxWidgets/wxWidgets.git
synced 2026-09-22 06:05:36 +08:00
moved proplist documentation to main book
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5114 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
Binary file not shown.
|
Before Width: | Height: | Size: 226 B |
@@ -1,106 +0,0 @@
|
||||
\chapter{Introduction}\label{introduction}
|
||||
\pagenumbering{arabic}%
|
||||
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
|
||||
The Property Sheet Classes help the programmer to specify complex dialogs and
|
||||
their relationship with their associated data. By specifying data as a
|
||||
wxPropertySheet containing wxProperty objects, the programmer can use
|
||||
a range of available or custom wxPropertyView classes to allow the user to
|
||||
edit this data. Classes derived from wxPropertyView act as mediators between the
|
||||
wxPropertySheet and the actual window (and associated panel items).
|
||||
|
||||
For example, the wxPropertyListView is a kind of wxPropertyView which displays
|
||||
data in a Visual Basic-style property list (see \helpref{the next section}{appearance} for
|
||||
screen shots). This is a listbox containing names and values, with
|
||||
an edit control and other optional controls via which the user edits the selected
|
||||
data item.
|
||||
|
||||
wxPropertyFormView is another kind of wxPropertyView which mediates between
|
||||
the data and a panel or dialog box which has already been created. This makes it a contender for
|
||||
the replacement of wxForm, since programmer-controlled layout is going to be much more
|
||||
satisfactory. If automatic layout is desired, then wxPropertyListView could be used instead.
|
||||
|
||||
The main intention of this class library was to provide property {\it list} behaviour, but
|
||||
it has been generalised as much as possible so that the concept of a property sheet and its viewers
|
||||
can reduce programming effort in a range of user interface tasks.
|
||||
|
||||
For further details on the classes and how they are used, please see \helpref{Property classes overview}{propertyoverview}.
|
||||
|
||||
\section{The appearance and behaviour of a property list view}\label{appearance}
|
||||
|
||||
The property list, as seen in an increasing number of development tools
|
||||
such as Visual Basic and Delphi, is a convenient and compact method for
|
||||
displaying and editing a number of items without the need for one
|
||||
control per item, and without the need for designing a special form. The
|
||||
controls are as follows:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item A listbox showing the properties and their current values, which has double-click
|
||||
properties dependent on the nature of the current property;
|
||||
\item a text editing area at the top of the display, allowing the user to edit
|
||||
the currently selected property if appropriate;
|
||||
\item `confirm' and `cancel' buttons to confirm or cancel an edit (for the property, not the
|
||||
whole sheet);
|
||||
\item an optional list that appears when the user can make a choice from several known possible values;
|
||||
\item a small Edit button to invoke `detailed editing' (perhaps showing or hiding the above value list, or
|
||||
maybe invoking a common dialog);
|
||||
\item optional OK/Close, Cancel and Help buttons for the whole dialog.
|
||||
\end{itemize}
|
||||
|
||||
The concept of `detailed editing' versus quick editing gives the user a choice
|
||||
of editing mode, so novice and expert behaviour can be catered for, or the user can just
|
||||
use what he feels comfortable with.
|
||||
|
||||
Behaviour alters depending on the kind of property being edited. For example, a boolean value has
|
||||
the following behaviour:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item Double-clicking on the item toggles between TRUE and FALSE.
|
||||
\item Showing the value list enables the user to select TRUE or FALSE.
|
||||
\item The user may be able to type in the word TRUE or FALSE, or the edit control
|
||||
may be read-only to disallow this since it is error-prone.
|
||||
\end{itemize}
|
||||
|
||||
A list of strings may pop up a dialog for editing them, a simple string just allows text editing,
|
||||
double-clicking a colour property may show a colour selector, double-clicking on a filename property may
|
||||
show a file selector (in addition to being able to type in the name in the edit control), etc.
|
||||
|
||||
Note that the `type' of property, such as string or integer, does not
|
||||
necessarily determine the behaviour of the property. The programmer has
|
||||
to be able to specify different behaviours for the same type, depending
|
||||
on the meaning of the property. For example, a colour and a filename may
|
||||
both be strings, but their editing behaviour should be different. This
|
||||
is why objects of type wxPropertyValidator need to be used, to define
|
||||
behaviour for a given class of properties or even specific property
|
||||
name. Objects of class wxPropertyView contain a list of property
|
||||
registries, which enable reuse of bunches of these validators in
|
||||
different circumstances. Or a wxProperty can be explicitly set to use a
|
||||
particular validator object.
|
||||
|
||||
The following screen shot of the property classes test program shows the
|
||||
user editing a string, which is constrained to be one of three possible
|
||||
values.
|
||||
|
||||
$$\image{8cm;0cm}{prop1.eps}$$\\
|
||||
|
||||
The second picture shows the user having entered a integer that
|
||||
was outside the range specified to the validator. Note that in this picture,
|
||||
the value list is hidden because it is not used when editing an integer.
|
||||
|
||||
$$\image{8cm;0cm}{prop2.eps}$$
|
||||
|
||||
\chapter{Files}\label{files}
|
||||
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
|
||||
The property class library comprises the following files:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item prop.h: base property class header
|
||||
\item proplist.h: wxPropertyListView and associated classes
|
||||
\item propform.h: wxPropertyListView and associated classes
|
||||
\item prop.cpp: base property class implementation
|
||||
\item proplist.cpp: wxPropertyListView and associated class implementions
|
||||
\item propform.cpp: wxPropertyFormView and associated class implementions
|
||||
\end{itemize}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 243 B |
Binary file not shown.
|
Before Width: | Height: | Size: 138 B |
@@ -1,27 +0,0 @@
|
||||
\chapter{Change log}\label{changes}
|
||||
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
|
||||
January - December 1998, Version 2.0
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item Conversion to wxWindows 2.0.
|
||||
\end{itemize}
|
||||
|
||||
November 26th 1995, Version 1.1
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item Added wxListOfStringsListValidator - allows adding, deleting, editing
|
||||
strings.
|
||||
\item Added wxPropertyValue::ClearList, wxPropertyValue::Delete,
|
||||
wxPropertyValue::wxPropertyValue(wxStringList *).
|
||||
\item Added wxPropertyValue::Set/GetModified, wxPropertySheet::SetAllModified.
|
||||
\item Added wxPropertyView::OnPropertyChanged support, for immediate feedback.
|
||||
\end{itemize}
|
||||
|
||||
October 1995, Version 1.0
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item First release.
|
||||
\end{itemize}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 231 B |
Binary file not shown.
|
Before Width: | Height: | Size: 164 B |
@@ -1,47 +0,0 @@
|
||||
\documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}
|
||||
\input psbox.tex
|
||||
% Remove this for processing with dvi2ps instead of dvips
|
||||
%\special{!/@scaleunit 1 def}
|
||||
\parskip=10pt
|
||||
\parindent=0pt
|
||||
\title{User Manual for wxWindows Property Sheet Classes Version 2.0}
|
||||
\winhelponly{\author{by Julian Smart, Anthemion Software\\$$\image{}{prop1}$$}}
|
||||
\winhelpignore{\author{Julian Smart, Anthemion Software}
|
||||
\date{December 1998}
|
||||
}
|
||||
\makeindex
|
||||
\begin{document}
|
||||
\maketitle
|
||||
\pagestyle{fancyplain}
|
||||
\bibliographystyle{plain}
|
||||
\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
\pagenumbering{roman}
|
||||
\tableofcontents
|
||||
|
||||
\chapter*{Copyright notice}
|
||||
\setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
|
||||
\begin{center}
|
||||
Copyright (c) 1998 Julian Smart, Anthemion Software
|
||||
\end{center}
|
||||
|
||||
Please see the wxWindows licence for conditions of use.
|
||||
|
||||
\input{body.tex}
|
||||
\input{classes.tex}
|
||||
\input{changes.tex}
|
||||
|
||||
%\newpage
|
||||
%
|
||||
% Note: In RTF, the \printindex must come before the
|
||||
% change of header/footer, since the \printindex inserts
|
||||
% the RTF \sect command which divides one chapter from
|
||||
% the next.
|
||||
\rtfonly{\printindex
|
||||
\addcontentsline{toc}{chapter}{Index}
|
||||
\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}%
|
||||
}
|
||||
\end{document}
|
||||
@@ -1,39 +0,0 @@
|
||||
|
||||
Prototype dialog editor and property sheet classes
|
||||
--------------------------------------------------
|
||||
|
||||
Julian Smart, October 4th 1995
|
||||
------------------------------
|
||||
|
||||
Here's what I've done so far on a lightweight dialog editor. The 16-bit
|
||||
Windows binaries in the bin directory are dialoged.exe (the dialog
|
||||
editor) and test.exe (a small property sheet demo).
|
||||
|
||||
Main points:
|
||||
|
||||
- You can create a new dialog box and add items to it.
|
||||
- You can move items around, and right-click
|
||||
to edit a few properties (very incomplete).
|
||||
- Can't write out .wxr files yet. Loading code is in
|
||||
wxWindows, but writing code is absent: should be put
|
||||
into wxWindows.
|
||||
- No attempt at resources other than dialogs yet.
|
||||
Should have menu editor too.
|
||||
- Should *somehow* have a protocol to allow
|
||||
existing resources e.g. in wxCLIPS/wxPython
|
||||
to be edited in situ.
|
||||
This should be made simpler by the existance of
|
||||
the plug-in event handler mechanism, which means you
|
||||
can temporarily handle all the events yourself.
|
||||
- See dialoged.cc: the main program is tiny because
|
||||
it's meant to be embeddable.
|
||||
- The wxPropertySheet (set of) classes are very
|
||||
general and should be put into wxWin and documented.
|
||||
|
||||
Comments, chivvying and help all appreciated. Maybe if
|
||||
I documented what I had, it would be easier for others
|
||||
to do some work on it.
|
||||
|
||||
Regards,
|
||||
|
||||
Julian
|
||||
@@ -1,21 +0,0 @@
|
||||
runTwice = yes
|
||||
titleFontSize = 12
|
||||
authorFontSize = 10
|
||||
chapterFontSize = 12
|
||||
sectionFontSize = 12
|
||||
subsectionFontSize = 12
|
||||
headerRule = yes
|
||||
footerRule = yes
|
||||
useHeadingStyles = yes
|
||||
contentsDepth = 2
|
||||
listItemIndent=40
|
||||
generateHPJ = yes
|
||||
htmlBrowseButtons = bitmap
|
||||
winHelpVersion = 3
|
||||
winHelpContents = yes
|
||||
winHelpTitle = "Property Classes Manual"
|
||||
truncateFilenames = yes
|
||||
\overview [2] {\rtfonly{See also }\sethotspotcolour{off}\sethotspotunderline{on}\winhelponly{\image{}{books.bmp}}
|
||||
\htmlonly{\image{}{books.gif}}\helpref{#1}{#2}
|
||||
\sethotspotcolour{on}\sethotspotunderline{on}}
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 137 B |
@@ -1,17 +0,0 @@
|
||||
[OPTIONS]
|
||||
BMROOT=d:\wx2\wxWind~1\utils\wxprop\docs ; Assume that bitmaps are where the source is
|
||||
TITLE=Property Classes Manual
|
||||
CONTENTS=Contents
|
||||
COMPRESS=HIGH
|
||||
|
||||
[FILES]
|
||||
wxprop.rtf
|
||||
|
||||
[CONFIG]
|
||||
CreateButton("Up", "&Up", "JumpId(`wxprop.hlp', `Contents')")
|
||||
BrowseButtons()
|
||||
|
||||
[MAP]
|
||||
|
||||
[BITMAPS]
|
||||
|
||||
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 4.2 KiB |
@@ -0,0 +1,12 @@
|
||||
\section{\class{wxBoolFormValidator}}\label{wxboolformvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a boolean value for a form view. The associated panel item must be a wxCheckBox.
|
||||
|
||||
\membersection{wxBoolFormValidator::wxBoolFormValidator}
|
||||
|
||||
\func{void}{wxBoolFormValidator}{\param{long }{flags=0}}
|
||||
|
||||
Constructor.
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
\section{\class{wxBoolListValidator}}\label{wxboollistvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a boolean value for a list view.
|
||||
|
||||
\membersection{wxBoolListValidator::wxBoolListValidator}
|
||||
|
||||
\func{void}{wxBoolListValidator}{\param{long }{flags=0}}
|
||||
|
||||
Constructor.
|
||||
|
||||
@@ -0,0 +1,106 @@
|
||||
\section{\class{wxProperty}}\label{wxproperty}
|
||||
|
||||
The {\bf wxProperty} class represents a property, with a \helpref{wxPropertyValue}{wxpropertyvalue}\rtfsp
|
||||
containing the actual value, a name a role, an optional validator, and
|
||||
an optional associated window.
|
||||
|
||||
A property might correspond to an actual C++ data member, or it
|
||||
might correspond to a conceptual property, such as the width of a window.
|
||||
There is no explicit data member {\it wxWindow::width}, but it may be convenient
|
||||
to invent such a property for the purposes of editing attributes of the window.
|
||||
The properties in the property sheet can be mapped to ``reality" by
|
||||
whatever means (in this case by calling wxWindow::SetSize when the user has
|
||||
finished editing the property sheet).
|
||||
|
||||
A validator may be associated with the property in order to ensure that this and
|
||||
only this validator will be used for editing and validating the property.
|
||||
An alternative method is to use the {\it role} parameter to specify what kind
|
||||
of validator would be appropriate; for example, specifying ``filename" for the role
|
||||
would allow the property view to find an appropriate validator at edit time.
|
||||
|
||||
|
||||
\membersection{wxProperty::wxProperty}
|
||||
|
||||
\func{void}{wxProperty}{\void}
|
||||
|
||||
\func{void}{wxProperty}{\param{wxProperty\& }{prop}}
|
||||
|
||||
\func{void}{wxProperty}{\param{wxString}{ name}, \param{wxString}{ role}, \param{wxPropertyValidator *}{validator=NULL}}
|
||||
|
||||
\func{void}{wxProperty}{\param{wxString}{ name}, \param{const wxPropertyValue\&}{ val}, \param{wxString}{ role}, \param{wxPropertyValidator *}{validator=NULL}}
|
||||
|
||||
Constructors.
|
||||
|
||||
\membersection{wxProperty::\destruct{wxProperty}}
|
||||
|
||||
\func{void}{\destruct{wxProperty}}{\void}
|
||||
|
||||
Destructor. Destroys the wxPropertyValue, and the property validator if there is one. However, if the
|
||||
actual C++ value in the wxPropertyValue is a pointer, the data in that variable is not destroyed.
|
||||
|
||||
\membersection{wxProperty::GetValue}
|
||||
|
||||
\func{wxPropertyValue\&}{GetValue}{\void}
|
||||
|
||||
Returns a reference to the property value.
|
||||
|
||||
\membersection{wxProperty::GetValidator}
|
||||
|
||||
\func{wxPropertyValidator *}{GetValidator}{\void}
|
||||
|
||||
Returns a pointer to the associated property validator (if any).
|
||||
|
||||
\membersection{wxProperty::GetName}
|
||||
|
||||
\func{wxString\&}{GetName}{\void}
|
||||
|
||||
Returns the name of the property.
|
||||
|
||||
\membersection{wxProperty::GetRole}
|
||||
|
||||
\func{wxRole\&}{GetRole}{\void}
|
||||
|
||||
Returns the role of the property, to be used when choosing an appropriate validator.
|
||||
|
||||
\membersection{wxProperty::GetWindow}
|
||||
|
||||
\func{wxWindow *}{GetWindow}{\void}
|
||||
|
||||
Returns the window associated with the property (if any).
|
||||
|
||||
\membersection{wxProperty::SetValue}
|
||||
|
||||
\func{void}{SetValue}{\param{wxPropertyValue\&}{ val}}
|
||||
|
||||
Sets the value of the property.
|
||||
|
||||
\membersection{wxProperty::SetName}
|
||||
|
||||
\func{void}{SetName}{\param{wxString\&}{ name}}
|
||||
|
||||
Sets the name of the property.
|
||||
|
||||
\membersection{wxProperty::SetRole}
|
||||
|
||||
\func{void}{SetRole}{\param{wxString\&}{ role}}
|
||||
|
||||
Sets the role of the property.
|
||||
|
||||
\membersection{wxProperty::SetValidator}
|
||||
|
||||
\func{void}{SetValidator}{\param{wxPropertyValidator *}{validator}}
|
||||
|
||||
Sets the validator: this will be deleted when the property is deleted.
|
||||
|
||||
\membersection{wxProperty::SetWindow}
|
||||
|
||||
\func{void}{SetWindow}{\param{wxWindow *}{win}}
|
||||
|
||||
Sets the window associated with the property.
|
||||
|
||||
\membersection{wxProperty::operator $=$}
|
||||
|
||||
\func{void}{operator $=$}{\param{const wxPropertyValue\&}{ val}}
|
||||
|
||||
Assignment operator.
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
\section{\class{wxFilenameListValidator}}\label{wxfilenamelistvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a filename for a list view, allowing the user to edit it textually and also popping up
|
||||
a file selector in ``detailed editing" mode.
|
||||
|
||||
\membersection{wxFilenameListValidator::wxFilenameListValidator}
|
||||
|
||||
\func{void}{wxFilenameListValidator}{\param{wxString }{message = ``Select a file"}, \param{wxString }{wildcard = ``*.*"},
|
||||
\param{long}{ flags=0}}
|
||||
|
||||
Constructor. Supply an optional message and wildcard.
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
\section{\class{wxPropertyFormDialog}}\label{wxpropertyformdialog}
|
||||
|
||||
The {\bf wxPropertyFormDialog} class is a prepackaged dialog which can
|
||||
be used for viewing a form property sheet. Pass a property form view object, and the dialog
|
||||
will pass OnClose and OnDefaultAction listbox messages to the view class for
|
||||
processing.
|
||||
|
||||
\membersection{wxPropertyFormDialog::wxPropertyFormDialog}
|
||||
|
||||
\func{void}{wxPropertyFormDialog}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent}, \param{char *}{title},
|
||||
\param{Bool}{ modal=FALSE}, \param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
|
||||
\param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{char *}{name=``dialogBox"}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyFormDialog::\destruct{wxPropertyFormDialog}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyFormDialog}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
\section{\class{wxPropertyFormFrame}}\label{wxpropertyformframe}
|
||||
|
||||
The {\bf wxPropertyFormFrame} class is a prepackaged frame which can
|
||||
be used for viewing a property form. Pass a property form view object, and the frame
|
||||
will pass OnClose messages to the view class for processing.
|
||||
|
||||
Call Initialize to create the panel and associate the view; override OnCreatePanel
|
||||
if you wish to use a panel class other than the default wxPropertyFormPanel.
|
||||
|
||||
\membersection{wxPropertyFormFrame::wxPropertyFormFrame}
|
||||
|
||||
\func{void}{wxPropertyFormFrame}{\param{wxPropertyFormView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title},
|
||||
\param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
|
||||
\param{long}{ style=wxSDI $\|$ wxDEFAULT\_FRAME}, \param{char *}{name=``frame"}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyFormFrame::\destruct{wxPropertyFormFrame}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyFormFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyFormFrame::GetPropertyPanel}
|
||||
|
||||
\func{wxPanel *}{GetPropertyPanel}{\void}
|
||||
|
||||
Returns the panel associated with the frame.
|
||||
|
||||
\membersection{wxPropertyFormFrame::Initialize}
|
||||
|
||||
\func{Bool}{Initialize}{\void}
|
||||
|
||||
Must be called to create the panel and associate the view with the panel and frame.
|
||||
|
||||
\membersection{wxPropertyFormFrame::OnCreatePanel}
|
||||
|
||||
\func{wxPanel *}{OnCreatePanel}{\param{wxFrame *}{parent}, \param{wxPropertyFormView *}{view}}
|
||||
|
||||
Creates a panel. Override this to create a panel type other than wxPropertyFormPanel.
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
\section{\class{wxPropertyFormPanel}}\label{wxpropertyformpanel}
|
||||
|
||||
The {\bf wxPropertyFormPanel} class is a prepackaged panel which can
|
||||
be used for viewing a property form. Pass a property form view object, and the panel
|
||||
will pass OnDefaultAction listbox messages to the view class for
|
||||
processing.
|
||||
|
||||
\membersection{wxPropertyFormPanel::wxPropertyFormPanel}
|
||||
|
||||
\func{void}{wxPropertyFormPanel}{\param{wxPropertyFormView *}{view}, \param{wxWindow *}{parent},
|
||||
\param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
|
||||
\param{long}{ style=0}, \param{char *}{name=``panel"}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyFormPanel::\destruct{wxPropertyFormPanel}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyFormPanel}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
\section{\class{wxPropertyFormValidator}}\label{wxpropertyformvalidator}
|
||||
|
||||
\overview{wxPropertyFormValidator overview}{wxpropertyformvalidatoroverview}
|
||||
|
||||
The {\bf wxPropertyFormValidator} class defines a base class for form validators. By overriding virtual functions,
|
||||
the programmer can create custom behaviour for kinds of property.
|
||||
|
||||
\membersection{wxPropertyFormValidator::wxPropertyFormValidator}
|
||||
|
||||
\func{void}{wxPropertyFormValidator}{\param{long}{ flags = 0}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyFormValidator::\destruct{wxPropertyFormValidator}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyFormValidator}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyFormValidator::OnCommand}
|
||||
|
||||
\func{Bool}{OnCommand}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
|
||||
\param{wxWindow *}{parentWindow}, \param{wxCommandEvent\& }{event}}
|
||||
|
||||
Called when the control corresponding to the property receives a command (if not intercepted
|
||||
by a callback associated with the actual control).
|
||||
|
||||
\membersection{wxPropertyFormValidator::OnCheckValue}
|
||||
|
||||
\func{Bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the view checks the property value. The value checked by this validator should be taken from the
|
||||
panel item corresponding to the property.
|
||||
|
||||
\membersection{wxPropertyFormValidator::OnDisplayValue}
|
||||
|
||||
\func{Bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Should display the property value in the appropriate control.
|
||||
|
||||
\membersection{wxPropertyFormValidator::OnDoubleClick}
|
||||
|
||||
\func{Bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the control corresponding to the property is double clicked (listboxes only).
|
||||
|
||||
\membersection{wxPropertyFormValidator::OnRetrieveValue}
|
||||
|
||||
\func{Bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Should do the transfer from the property editing area to the property itself.
|
||||
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
\section{\class{wxPropertyFormView}}\label{wxpropertyformview}
|
||||
|
||||
\overview{wxPropertyFormView overview}{wxpropertyformviewoverview}
|
||||
|
||||
The {\bf wxPropertyFormView} class shows a wxPropertySheet as a view onto a panel or dialog
|
||||
box which has already been created.
|
||||
|
||||
\membersection{wxPropertyFormView::wxPropertyFormView}
|
||||
|
||||
\func{void}{wxPropertyFormView}{\param{long}{ flags = 0}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyFormView::\destruct{wxPropertyFormView}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyFormView}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyFormView::AssociateNames}\label{wxpropertyformviewassociatenames}
|
||||
|
||||
\func{void}{AssociateNames}{\void}
|
||||
|
||||
Associates the properties with the controls on the panel. For each panel item, if the
|
||||
panel item name is the same as a property name, the two objects will be associated.
|
||||
This function should be called manually since the programmer may wish to do the
|
||||
association manually.
|
||||
|
||||
\membersection{wxPropertyFormView::Check}\label{wxpropertyformviewcheck}
|
||||
|
||||
\func{Bool}{Check}{\void}
|
||||
|
||||
Checks all properties by calling the appropriate validators; returns FALSE if a validation failed.
|
||||
|
||||
\membersection{wxPropertyFormView::GetPanel}\label{wxpropertyformviewgetpanel}
|
||||
|
||||
\func{wxPanel *}{GetPanel}{\void}
|
||||
|
||||
Returns the panel associated with the view.
|
||||
|
||||
\membersection{wxPropertyFormView::GetManagedWindow}\label{wxpropertyformviewgetmanagedwindow}
|
||||
|
||||
\func{wxWindow *}{GetManagedWindow}{\void}
|
||||
|
||||
Returns the managed window (a frame or dialog) associated with the view.
|
||||
|
||||
\membersection{wxPropertyFormView::OnOk}\label{wxpropertyformviewonok}
|
||||
|
||||
\func{void}{OnOk}{\void}
|
||||
|
||||
Virtual function that will be called when the OK button on the physical window is pressed.
|
||||
By default, checks and updates the form values, closes and deletes the frame or dialog, then deletes the view.
|
||||
|
||||
\membersection{wxPropertyFormView::OnCancel}\label{wxpropertyformviewoncancel}
|
||||
|
||||
\func{void}{OnCancel}{\void}
|
||||
|
||||
Virtual function that will be called when the Cancel button on the physical window is pressed.
|
||||
By default, closes and deletes the frame or dialog, then deletes the view.
|
||||
|
||||
\membersection{wxPropertyFormView::OnHelp}\label{wxpropertyformviewonhelp}
|
||||
|
||||
\func{void}{OnHelp}{\void}
|
||||
|
||||
Virtual function that will be called when the Help button on the physical window is pressed.
|
||||
This needs to be overridden by the application for anything interesting to happen.
|
||||
|
||||
\membersection{wxPropertyFormView::OnRevert}\label{wxpropertyformviewonrevert}
|
||||
|
||||
\func{void}{OnRevert}{\void}
|
||||
|
||||
Virtual function that will be called when the Revert button on the physical window is pressed.
|
||||
By default transfers the wxProperty values to the panel items (in effect
|
||||
undoing any unsaved changes in the items).
|
||||
|
||||
\membersection{wxPropertyFormView::OnUpdate}\label{wxpropertyformviewonupdate}
|
||||
|
||||
\func{void}{OnUpdate}{\void}
|
||||
|
||||
Virtual function that will be called when the Update button on the physical window is pressed.
|
||||
By defaults transfers the displayed values to the wxProperty objects.
|
||||
|
||||
\membersection{wxPropertyFormView::SetManagedWindow}\label{wxpropertyformviewsetmanagedwindow}
|
||||
|
||||
\func{void}{SetManagedWindow}{\param{wxWindow *}{win}}
|
||||
|
||||
Sets the managed window (a frame or dialog) associated with the view.
|
||||
|
||||
\membersection{wxPropertyFormView::TransferToDialog}\label{wxpropertyformviewtransfertodialog}
|
||||
|
||||
\func{Bool}{TransferToDialog}{\void}
|
||||
|
||||
Transfers property values to the controls in the dialog.
|
||||
|
||||
\membersection{wxPropertyFormView::TransferToPropertySheet}\label{wxpropertyformviewtransfertopropertysheet}
|
||||
|
||||
\func{Bool}{TransferToPropertySheet}{\void}
|
||||
|
||||
Transfers property values from the controls in the dialog to the property sheet.
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
\section{\class{wxIntegerFormValidator}}\label{wxintegerformvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a range of integer values for a form view. The associated panel item must be a wxText
|
||||
or wxSlider.
|
||||
|
||||
\membersection{wxIntegerFormValidator::wxIntegerFormValidator}
|
||||
|
||||
\func{void}{wxIntegerFormValidator}{\param{long }{min=0}, \param{long }{max=0},
|
||||
\param{long}{ flags=0}}
|
||||
|
||||
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
\section{\class{wxIntegerListValidator}}\label{wxintegerlistvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a range of integer values for a list view.
|
||||
|
||||
\membersection{wxIntegerListValidator::wxIntegerListValidator}
|
||||
|
||||
\func{void}{wxIntegerListValidator}{\param{long }{min=0}, \param{long }{max=0},
|
||||
\param{long}{ flags=wxPROP\_ALLOW\_TEXT\_EDITING}}
|
||||
|
||||
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
\section{\class{wxPropertyListDialog}}\label{wxpropertylistdialog}
|
||||
|
||||
The {\bf wxPropertyListDialog} class is a prepackaged dialog which can
|
||||
be used for viewing a property list. Pass a property list view object, and the dialog
|
||||
will pass OnClose and OnDefaultAction listbox messages to the view class for
|
||||
processing.
|
||||
|
||||
\membersection{wxPropertyListDialog::wxPropertyListDialog}
|
||||
|
||||
\func{void}{wxPropertyListDialog}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent}, \param{char *}{title},
|
||||
\param{Bool}{ modal=FALSE}, \param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
|
||||
\param{long}{ style=wxDEFAULT\_DIALOG\_STYLE}, \param{char *}{name=``dialogBox"}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyListDialog::\destruct{wxPropertyListDialog}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyListDialog}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
\section{\class{wxPropertyListFrame}}\label{wxpropertylistframe}
|
||||
|
||||
The {\bf wxPropertyListFrame} class is a prepackaged frame which can
|
||||
be used for viewing a property list. Pass a property list view object, and the frame
|
||||
will pass OnClose messages to the view class for processing.
|
||||
|
||||
Call Initialize to create the panel and associate the view; override OnCreatePanel
|
||||
if you wish to use a panel class other than the default wxPropertyListPanel.
|
||||
|
||||
\membersection{wxPropertyListFrame::wxPropertyListFrame}
|
||||
|
||||
\func{void}{wxPropertyListFrame}{\param{wxPropertyListView *}{view}, \param{wxFrame *}{parent}, \param{char *}{title},
|
||||
\param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
|
||||
\param{long}{ style=wxSDI $\|$ wxDEFAULT\_FRAME}, \param{char *}{name=``frame"}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyListFrame::\destruct{wxPropertyListFrame}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyListFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyListFrame::GetPropertyPanel}
|
||||
|
||||
\func{wxPanel *}{GetPropertyPanel}{\void}
|
||||
|
||||
Returns the panel associated with the frame.
|
||||
|
||||
\membersection{wxPropertyListFrame::Initialize}
|
||||
|
||||
\func{Bool}{Initialize}{\void}
|
||||
|
||||
Must be called to create the panel and associate the view with the panel and frame.
|
||||
|
||||
\membersection{wxPropertyListFrame::OnCreatePanel}
|
||||
|
||||
\func{wxPanel *}{OnCreatePanel}{\param{wxFrame *}{parent}, \param{wxPropertyListView *}{view}}
|
||||
|
||||
Creates a panel. Override this to create a panel type other than wxPropertyListPanel.
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
\section{\class{wxPropertyListPanel}}\label{wxpropertylistpanel}
|
||||
|
||||
The {\bf wxPropertyListPanel} class is a prepackaged panel which can
|
||||
be used for viewing a property list. Pass a property list view object, and the panel
|
||||
will pass OnDefaultAction listbox messages to the view class for
|
||||
processing.
|
||||
|
||||
\membersection{wxPropertyListPanel::wxPropertyListPanel}
|
||||
|
||||
\func{void}{wxPropertyListPanel}{\param{wxPropertyListView *}{view}, \param{wxWindow *}{parent},
|
||||
\param{int}{ x=-1}, \param{int}{ y=-1}, \param{int}{ width=-1}, \param{int}{height=-1},
|
||||
\param{long}{ style=0}, \param{char *}{name=``panel"}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyListPanel::\destruct{wxPropertyListPanel}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyListPanel}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,108 @@
|
||||
\section{\class{wxPropertyListValidator}}\label{wxpropertylistvalidator}
|
||||
|
||||
\overview{wxPropertyListValidator overview}{wxpropertylistvalidatoroverview}
|
||||
|
||||
The {\bf wxPropertyListValidator} abstract class is the base class for
|
||||
deriving validators for property lists.
|
||||
|
||||
\membersection{wxPropertyListValidator::wxPropertyListValidator}
|
||||
|
||||
\func{void}{wxPropertyListValidator}{\param{long}{ flags = wxPROP\_ALLOW\_TEXT\_EDITING}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyListValidator::\destruct{wxPropertyListValidator}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyListValidator}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnCheckValue}
|
||||
|
||||
\func{Bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the Tick (Confirm) button is pressed or focus is list. Return FALSE if the value
|
||||
was invalid, which is a signal restores the old value. Return TRUE if the value was valid.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnClearControls}
|
||||
|
||||
\func{Bool}{OnClearControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Allows the clearing (enabling, disabling) of property list controls, when the focus leaves the current property.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnClearDetailControls}
|
||||
|
||||
\func{Bool}{OnClearDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the focus is lost, if the validator is in detailed editing mode.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnDisplayValue}
|
||||
|
||||
\func{Bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Should display the value in the appropriate controls. The default implementation gets the
|
||||
textual value from the property and inserts it into the text edit control.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnDoubleClick}
|
||||
|
||||
\func{Bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the property is double clicked. Extra functionality can be provided,
|
||||
such as cycling through possible values.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnEdit}
|
||||
|
||||
\func{Bool}{OnEdit}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the Edit (detailed editing) button is pressed. The default implementation
|
||||
calls wxPropertyListView::BeginDetailedEditing; a filename validator (for example) overrides
|
||||
this function to show the file selector.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnPrepareControls}
|
||||
|
||||
\func{Bool}{OnPrepareControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called to allow the validator to setup the display, such enabling or disabling buttons, and
|
||||
setting the values and selection in the standard listbox control (the one optionally used for displaying
|
||||
value options).
|
||||
|
||||
\membersection{wxPropertyListValidator::OnPrepareDetailControls}
|
||||
|
||||
\func{Bool}{OnPrepareDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the property is edited `in detail', i.e. when the Edit button is pressed.
|
||||
|
||||
\membersection{wxPropertyListValidator::OnRetrieveValue}
|
||||
|
||||
\func{Bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when Tick (Confirm) is pressed or focus is lost or view wants to update
|
||||
the property list. Should do the transfer from the property editing area to the property itself
|
||||
|
||||
\membersection{wxPropertyListValidator::OnSelect}
|
||||
|
||||
\func{Bool}{OnSelect}{\param{Bool}{ select}, \param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the property is selected or deselected: typically displays the value
|
||||
in the edit control (having chosen a suitable control to display: (non)editable text or listbox).
|
||||
|
||||
\membersection{wxPropertyListValidator::OnValueListSelect}
|
||||
|
||||
\func{Bool}{OnValueListSelect}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view},
|
||||
\param{wxWindow *}{parentWindow}}
|
||||
|
||||
Called when the value listbox is selected. The default behaviour is to copy
|
||||
string to text control, and retrieve the value into the property.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
\section{\class{wxListOfStringsListValidator}}\label{wxlistofstringslistvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a list of strings for a list view. When editing the property,
|
||||
a dialog box is presented for adding, deleting or editing entries in the list.
|
||||
At present no constraints may be supplied.
|
||||
|
||||
You can construct a string list property value by constructing a wxStringList object.
|
||||
|
||||
For example:
|
||||
|
||||
\begin{verbatim}
|
||||
myListValidatorRegistry.RegisterValidator((wxString)"stringlist",
|
||||
new wxListOfStringsListValidator);
|
||||
|
||||
wxStringList *strings = new wxStringList("earth", "fire", "wind", "water", NULL);
|
||||
|
||||
sheet->AddProperty(new wxProperty("fred", strings, "stringlist"));
|
||||
\end{verbatim}
|
||||
|
||||
\membersection{wxListOfStringsListValidator::wxListofStringsListValidator}
|
||||
|
||||
\func{void}{wxListOfStringsListValidator}{\param{long}{ flags=0}}
|
||||
|
||||
Constructor.
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
\section{\class{wxPropertyListView}}\label{wxpropertylistview}
|
||||
|
||||
\overview{wxPropertyListView overview}{wxpropertylistviewoverview}
|
||||
|
||||
The {\bf wxPropertyListView} class shows a wxPropertySheet as a Visual Basic-style property list.
|
||||
|
||||
\membersection{wxPropertyListView::wxPropertyListView}
|
||||
|
||||
\func{void}{wxPropertyListView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
|
||||
|
||||
Constructor.
|
||||
|
||||
The {\it flags} argument can be a bit list of the following:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item wxPROP\_BUTTON\_CLOSE
|
||||
\item wxPROP\_BUTTON\_OK
|
||||
\item wxPROP\_BUTTON\_CANCEL
|
||||
\item wxPROP\_BUTTON\_CHECK\_CROSS
|
||||
\item wxPROP\_BUTTON\_HELP
|
||||
\item wxPROP\_DYNAMIC\_VALUE\_FIELD
|
||||
\item wxPROP\_PULLDOWN
|
||||
\end{itemize}
|
||||
|
||||
\membersection{wxPropertyListView::\destruct{wxPropertyListView}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyListView}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyListView::AssociatePanel}\label{wxpropertylistviewassociatepanel}
|
||||
|
||||
\func{void}{AssociatePanel}{\param{wxPanel *}{panel}}
|
||||
|
||||
Associates the window on which the controls will be displayed, with the view (sets an internal pointer to the window).
|
||||
|
||||
\membersection{wxPropertyListView::BeginShowingProperty}\label{wxpropertylistviewbeginshowingproperty}
|
||||
|
||||
\func{Bool}{BeginShowingProperty}{\param{wxProperty *}{property}}
|
||||
|
||||
Finds the appropriate validator and loads the property into the controls, by calling
|
||||
wxPropertyValidator::OnPrepareControls and then wxPropertyListView::DisplayProperty.
|
||||
|
||||
\membersection{wxPropertyListView::DisplayProperty}\label{wxpropertylistviewdisplayproperty}
|
||||
|
||||
\func{Bool}{DisplayProperty}{\param{wxProperty *}{property}}
|
||||
|
||||
Calls wxPropertyValidator::OnDisplayValue for the current property's validator. This function
|
||||
gets called by wxPropertyListView::BeginShowingProperty, which is in turn called
|
||||
from ShowProperty, called by OnPropertySelect, called by the listbox callback when selected.
|
||||
|
||||
\membersection{wxPropertyListView::EndShowingProperty}\label{wxpropertylistviewendshowingproperty}
|
||||
|
||||
\func{Bool}{EndShowingProperty}{\param{wxProperty *}{property}}
|
||||
|
||||
Finds the appropriate validator and unloads the property from the controls, by calling
|
||||
wxPropertyListView::RetrieveProperty, wxPropertyValidator::OnClearControls and (if we're in
|
||||
detailed editing mdoe) wxPropertyValidator::OnClearDetailControls.
|
||||
|
||||
\membersection{wxPropertyListView::GetPanel}\label{wxpropertylistviewgetpanel}
|
||||
|
||||
\func{wxPanel *}{GetPanel}{\void}
|
||||
|
||||
Returns the panel associated with the view.
|
||||
|
||||
\membersection{wxPropertyListView::GetManagedWindow}\label{wxpropertylistviewgetmanagedwindow}
|
||||
|
||||
\func{wxWindow *}{GetManagedWindow}{\void}
|
||||
|
||||
Returns the managed window (a frame or dialog) associated with the view.
|
||||
|
||||
\membersection{wxPropertyListView::GetWindowCancelButton}\label{wxpropertylistviewgetwindowcancelbutton}
|
||||
|
||||
\func{wxButton *}{GetWindowCancelButton}{\void}
|
||||
|
||||
Returns the window cancel button, if any.
|
||||
|
||||
\membersection{wxPropertyListView::GetWindowCloseButton}\label{wxpropertylistviewgetwindowclosebutton}
|
||||
|
||||
\func{wxButton *}{GetWindowCloseButton}{\void}
|
||||
|
||||
Returns the window close or OK button, if any.
|
||||
|
||||
\membersection{wxPropertyListView::GetWindowHelpButton}\label{wxpropertylistviewgetwindowhelpbutton}
|
||||
|
||||
\func{wxButton *}{GetWindowHelpButton}{\void}
|
||||
|
||||
Returns the window help button, if any.
|
||||
|
||||
\membersection{wxPropertyListView::SetManagedWindow}\label{wxpropertylistviewsetmanagedwindow}
|
||||
|
||||
\func{void}{SetManagedWindow}{\param{wxWindow *}{win}}
|
||||
|
||||
Sets the managed window (a frame or dialog) associated with the view.
|
||||
|
||||
\membersection{wxPropertyListView::UpdatePropertyDisplayInList}\label{wxpropertylistviewupdatepropdisplay}
|
||||
|
||||
\func{Bool}{UpdatePropertyDisplayInList}{\param{wxProperty *}{property}}
|
||||
|
||||
Updates the display for the given changed property.
|
||||
|
||||
\membersection{wxPropertyListView::UpdatePropertyList}\label{wxpropertylistviewupdateproplist}
|
||||
|
||||
\func{Bool}{UpdatePropertyList}{\param{Bool }{clearEditArea = TRUE}}
|
||||
|
||||
Updates the whole property list display.
|
||||
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
\section{\class{wxPropertyValidatorRegistry}}\label{wxpropertyvalidatorregistry}
|
||||
|
||||
The {\bf wxPropertyValidatorRegistry} class is used for storing validators,
|
||||
indexed by the `role name' of the property, by which groups of property
|
||||
can be identified for the purpose of validation and editing.
|
||||
|
||||
\membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry}
|
||||
|
||||
\func{void}{wxPropertyValidatorRegistry}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyValidatorRegistry::\destruct{wxPropertyValidatorRegistry}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyValidatorRegistry}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyValidatorRegistry::Clear}
|
||||
|
||||
\func{void}{ClearRegistry}{\void}
|
||||
|
||||
Clears the registry, deleting the validators.
|
||||
|
||||
\membersection{wxPropertyValidatorRegistry::GetValidator}
|
||||
|
||||
\func{wxPropertyValidator *}{GetValidator}{\param{wxString\& }{roleName}}
|
||||
|
||||
Retrieve a validator by the property role name.
|
||||
|
||||
\membersection{wxPropertyValidatorRegistry::RegisterValidator}\label{wxpropertyvalidatorregistervalidator}
|
||||
|
||||
\func{void}{RegisterValidator}{\param{wxString\& }{roleName}, \param{wxPropertyValidator *}{validator}}
|
||||
|
||||
Register a validator with the registry. {\it roleName} is a name indicating the
|
||||
role of the property, such as ``filename''. Later, when a validator is chosen for
|
||||
editing a property, this role name is matched against the class names of the property,
|
||||
if the property does not already have a validator explicitly associated with it.
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
\section{\class{wxRealFormValidator}}\label{wxrealformvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a range of real values for form views. The associated panel item must be a wxText.
|
||||
|
||||
\membersection{wxRealFormValidator::wxRealFormValidator}
|
||||
|
||||
\func{void}{wxRealFormValidator}{\param{float }{min=0.0}, \param{float }{max=0.0},
|
||||
\param{long}{ flags=0}}
|
||||
|
||||
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
\section{\class{wxRealListValidator}}\label{wxreallistvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a range of real values for property lists.
|
||||
|
||||
\membersection{wxRealListValidator::wxreallistvalidator}
|
||||
|
||||
\func{void}{wxRealListValidator}{\param{float }{min=0.0}, \param{float }{max=0.0},
|
||||
\param{long}{ flags=wxPROP\_ALLOW\_TEXT\_EDITING}}
|
||||
|
||||
Constructor. Assigning zero to minimum and maximum values indicates that there is no range to check.
|
||||
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
\section{\class{wxPropertySheet}}\label{wxpropertysheet}
|
||||
|
||||
\overview{wxPropertySheet overview}{wxpropertysheetoverview}
|
||||
|
||||
The {\bf wxPropertySheet} class is used for storing a number of
|
||||
wxProperty objects (essentially names and values).
|
||||
|
||||
\membersection{wxPropertySheet::wxPropertySheet}
|
||||
|
||||
\func{void}{wxPropertySheet}{\param{const wxString}{ name = ""}}
|
||||
|
||||
Constructor. Sets property sheet's name to name if present.
|
||||
|
||||
\membersection{wxPropertySheet::\destruct{wxPropertySheet}}
|
||||
|
||||
\func{void}{\destruct{wxPropertySheet}}{\void}
|
||||
|
||||
Destructor. Destroys all contained properties.
|
||||
|
||||
\membersection{wxPropertySheet::AddProperty}\label{wxpropertysheetaddproperty}
|
||||
|
||||
\func{void}{AddProperty}{\param{wxProperty *}{property}}
|
||||
|
||||
Adds a property to the sheet.
|
||||
|
||||
\membersection{wxPropertySheet::Clear}\label{wxpropertysheetclear}
|
||||
|
||||
\func{void}{Clear}{\void}
|
||||
|
||||
Clears all the properties from the sheet (deleting them).
|
||||
|
||||
\membersection{wxPropertySheet::GetName}\label{wxpropertysheetgetname}
|
||||
|
||||
\func{wxString}{GetName}{\void}
|
||||
|
||||
Gets the sheet's name.
|
||||
|
||||
\membersection{wxPropertySheet::GetProperty}\label{wxpropertysheetgetproperty}
|
||||
|
||||
\func{wxProperty *}{GetProperty}{\param{wxString}{ name}}
|
||||
|
||||
Gets a property by name.
|
||||
|
||||
\membersection{wxPropertySheet::GetProperties}\label{wxpropertysheetgetproperties}
|
||||
|
||||
\func{wxList\&}{GetProperties}{\void}
|
||||
|
||||
Returns a reference to the internal list of properties.
|
||||
|
||||
\membersection{wxPropertySheet::HasProperty}\label{wxpropertysheethasproperty}
|
||||
|
||||
\func{bool}{HasProperty}{\param{wxString}{ propname}}
|
||||
|
||||
Returns true if sheet contains property propname.
|
||||
|
||||
\membersection{wxPropertySheet::RemoveProperty}\label{wxpropertysheetremoveproperty}
|
||||
|
||||
\func{void}{RemoveProperty}{\param{wxString}{ propname}}
|
||||
|
||||
Removes property propname from sheet, deleting it.
|
||||
|
||||
\membersection{wxPropertySheet::SetName}\label{wxpropertysheetsetname}
|
||||
|
||||
\func{void}{SetName}{\param{wxString}{ sheetname}}
|
||||
|
||||
Set the sheet's name to sheetname
|
||||
|
||||
\membersection{wxPropertySheet::SetProperty}\label{wxpropertysheetsetproperty}
|
||||
|
||||
\func{bool}{SetProperty}{\param{wxString}{ propname}, \param{wxPropertyValue}{ value}}
|
||||
|
||||
Sets property propname to value. Returns false if property is not a member of sheet.
|
||||
|
||||
\membersection{wxPropertySheet::SetAllModified}
|
||||
|
||||
\func{void}{SetAllModified}{\param{Bool}{ flag}}
|
||||
|
||||
Sets the `modified' flag of each property value.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
\section{\class{wxStringListValidator}}\label{wxstringlistvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a string value, with an optional choice of possible values.
|
||||
|
||||
\membersection{wxStringListValidator::wxStringListValidator}
|
||||
|
||||
\func{void}{wxStringListValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}}
|
||||
|
||||
Constructor. Supply a list of strings to indicate a choice, or no strings to allow the
|
||||
user to freely edit the string. The string list will be deleted when the validator is deleted.
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
\section{\class{wxStringFormValidator}}\label{wxstringformvalidator}
|
||||
|
||||
\overview{Validator classes}{proplistvalidatorclasses}
|
||||
|
||||
This class validates a string value for a form view, with an optional choice of possible values.
|
||||
The associated panel item must be a wxText, wxListBox or wxChoice. For wxListBox and wxChoice items,
|
||||
if the item is empty, the validator attempts to initialize the item from the strings in
|
||||
the validator. Note that this does not happen for XView wxChoice items since XView cannot reinitialize a wxChoice.
|
||||
|
||||
\membersection{wxStringFormValidator::wxStringFormValidator}
|
||||
|
||||
\func{void}{wxStringFormValidator}{\param{wxStringList *}{list=NULL}, \param{long}{ flags=0}}
|
||||
|
||||
Constructor. Supply a list of strings to indicate a choice, or no strings to allow the
|
||||
user to freely edit the string. The string list will be deleted when the validator is deleted.
|
||||
|
||||
|
||||
@@ -0,0 +1,242 @@
|
||||
\section{\class{wxPropertyValue}}\label{wxpropertyvalue}
|
||||
|
||||
The {\bf wxPropertyValue} class represents the value of a property,
|
||||
and is normally associated with a wxProperty object.
|
||||
|
||||
A wxPropertyValue has one of the following types:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item wxPropertyValueNull
|
||||
\item wxPropertyValueInteger
|
||||
\item wxPropertyValueReal
|
||||
\item wxPropertyValueBool
|
||||
\item wxPropertyValueString
|
||||
\item wxPropertyValueList
|
||||
\item wxPropertyValueIntegerPtr
|
||||
\item wxPropertyValueRealPtr
|
||||
\item wxPropertyValueBoolPtr
|
||||
\item wxPropertyValueStringPtr
|
||||
\end{itemize}
|
||||
|
||||
\membersection{wxPropertyValue::wxPropertyValue}
|
||||
|
||||
\func{void}{wxPropertyValue}{\void}
|
||||
|
||||
Default constructor.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{const wxPropertyValue\& }{copyFrom}}
|
||||
|
||||
Copy constructor.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{char *}{val}}
|
||||
|
||||
Construction from a string value.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{long}{ val}}
|
||||
|
||||
Construction from an integer value. You may need to cast to (long) to
|
||||
avoid confusion with other constructors (such as the Bool constructor).
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{Bool}{ val}}
|
||||
|
||||
Construction from a boolean value.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{float}{ val}}
|
||||
|
||||
Construction from a floating point value.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{double}{ val}}
|
||||
|
||||
Construction from a floating point value.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{wxList *}{ val}}
|
||||
|
||||
Construction from a list of wxPropertyValue objects. The
|
||||
list, but not each contained wxPropertyValue, will be deleted
|
||||
by the constructor. The wxPropertyValues will be assigned to
|
||||
this wxPropertyValue list. In other words, so do not delete wxList or
|
||||
its data after calling this constructor.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{wxStringList *}{ val}}
|
||||
|
||||
Construction from a list of strings. The list (including the strings
|
||||
contained in it) will be deleted by the constructor, so do not
|
||||
destroy {\it val} explicitly.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{char **}{val}}
|
||||
|
||||
Construction from a string pointer.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{long *}{val}}
|
||||
|
||||
Construction from an integer pointer.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{Bool *}{val}}
|
||||
|
||||
Construction from an boolean pointer.
|
||||
|
||||
\func{void}{wxPropertyValue}{\param{float *}{val}}
|
||||
|
||||
Construction from a floating point pointer.
|
||||
|
||||
The last four constructors use pointers to various C++ types, and do not
|
||||
store the types themselves; this allows the values to stand in for actual
|
||||
data values defined elsewhere.
|
||||
|
||||
\membersection{wxPropertyValue::\destruct{wxPropertyValue}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyValue}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyValue::Append}
|
||||
|
||||
\func{void}{Append}{\param{wxPropertyValue *}{expr}}
|
||||
|
||||
Appends a property value to the list.
|
||||
|
||||
\membersection{wxPropertyValue::BoolValue}
|
||||
|
||||
\func{Bool}{BoolValue}{\void}
|
||||
|
||||
Returns the boolean value.
|
||||
|
||||
\membersection{wxPropertyValue::BoolValuePtr}
|
||||
|
||||
\func{Bool *}{BoolValuePtr}{\void}
|
||||
|
||||
Returns the pointer to the boolean value.
|
||||
|
||||
\membersection{wxPropertyValue::ClearList}
|
||||
|
||||
\func{void}{ClearList}{\void}
|
||||
|
||||
Deletes the contents of the list.
|
||||
|
||||
\membersection{wxPropertyValue::Delete}
|
||||
|
||||
\func{void}{Delete}{\param{wxPropertyValue *}{expr}}
|
||||
|
||||
Deletes {\it expr} from this list.
|
||||
|
||||
\membersection{wxPropertyValue::GetFirst}
|
||||
|
||||
\func{wxPropertyValue *}{GetFirst}{\void}
|
||||
|
||||
Gets the first value in the list.
|
||||
|
||||
\membersection{wxPropertyValue::GetLast}
|
||||
|
||||
\func{wxPropertyValue *}{GetFirst}{\void}
|
||||
|
||||
Gets the last value in the list.
|
||||
|
||||
\membersection{wxPropertyValue::GetModified}
|
||||
|
||||
\func{Bool}{GetModified}{\void}
|
||||
|
||||
Returns TRUE if the value was modified since being created
|
||||
(or since SetModified was called).
|
||||
|
||||
\membersection{wxPropertyValue::GetNext}
|
||||
|
||||
\func{wxPropertyValue *}{GetNext}{\void}
|
||||
|
||||
Gets the next value in the list (the one after `this').
|
||||
|
||||
\membersection{wxPropertyValue::GetStringRepresentation}
|
||||
|
||||
\func{wxString}{GetStringRepresentation}{\void}
|
||||
|
||||
Gets a string representation of the value.
|
||||
|
||||
\membersection{wxPropertyValue::IntegerValue}
|
||||
|
||||
\func{long}{IntegerValue}{\void}
|
||||
|
||||
Returns the integer value.
|
||||
|
||||
\membersection{wxPropertyValue::Insert}
|
||||
|
||||
\func{void}{Insert}{\param{wxPropertyValue *}{expr}}
|
||||
|
||||
Inserts a property value at the front of a list.
|
||||
|
||||
\membersection{wxPropertyValue::IntegerValuePtr}
|
||||
|
||||
\func{long *}{IntegerValuePtr}{\void}
|
||||
|
||||
Returns the pointer to the integer value.
|
||||
|
||||
\membersection{wxPropertyValue::Nth}
|
||||
|
||||
\func{wxPropertyValue *}{Nth}{\param{int}{ n}}
|
||||
|
||||
Returns the nth value of a list expression (starting from zero).
|
||||
|
||||
\membersection{wxPropertyValue::Number}
|
||||
|
||||
\func{int}{Number}{\void}
|
||||
|
||||
Returns the number of elements in a list expression.
|
||||
|
||||
\membersection{wxPropertyValue::RealValue}
|
||||
|
||||
\func{float}{RealValue}{\void}
|
||||
|
||||
Returns the floating point value.
|
||||
|
||||
\membersection{wxPropertyValue::RealValuePtr}
|
||||
|
||||
\func{float *}{RealValuePtr}{\void}
|
||||
|
||||
Returns the pointer to the floating point value.
|
||||
|
||||
\membersection{wxPropertyValue::SetModified}
|
||||
|
||||
\func{void}{SetModified}{\param{Bool}{ flag}}
|
||||
|
||||
Sets the `modified' flag.
|
||||
|
||||
\membersection{wxPropertyValue::StringValue}
|
||||
|
||||
\func{char *}{StringValue}{\void}
|
||||
|
||||
Returns the string value.
|
||||
|
||||
\membersection{wxPropertyValue::StringValuePtr}
|
||||
|
||||
\func{char **}{StringValuePtr}{\void}
|
||||
|
||||
Returns the pointer to the string value.
|
||||
|
||||
\membersection{wxPropertyValue::Type}
|
||||
|
||||
\func{wxPropertyValueType}{Type}{\void}
|
||||
|
||||
Returns the value type.
|
||||
|
||||
\membersection{wxPropertyValue::operator $=$}
|
||||
|
||||
\func{void}{operator $=$}{\param{const wxPropertyValue\& }{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const char *}{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const long }{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const Bool }{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const float }{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const char **}{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const long *}{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const Bool *}{val}}
|
||||
|
||||
\func{void}{operator $=$}{\param{const float *}{val}}
|
||||
|
||||
Assignment operators.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
\section{\class{wxPropertyValidator}}\label{wxpropertyvalidator}
|
||||
|
||||
\overview{wxPropertyValidator overview}{wxpropertyvalidatoroverview}
|
||||
|
||||
The {\bf wxPropertyValidator} abstract class is the base class for deriving
|
||||
validators for properties.
|
||||
|
||||
\membersection{wxPropertyValidator::wxPropertyValidator}
|
||||
|
||||
\func{void}{wxPropertyValidator}{\param{long}{ flags = 0}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxPropertyValidator::\destruct{wxPropertyValidator}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyValidator}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyValidator::GetFlags}
|
||||
|
||||
\func{long}{GetFlags}{\void}
|
||||
|
||||
Returns the flags for the validator.
|
||||
|
||||
\membersection{wxPropertyValidator::GetValidatorProperty}
|
||||
|
||||
\func{wxProperty *}{GetValidatorProperty}{\void}
|
||||
|
||||
Gets the property for the validator.
|
||||
|
||||
\membersection{wxPropertyValidator::SetValidatorProperty}
|
||||
|
||||
\func{void}{SetValidatorProperty}{\param{wxProperty *}{property}}
|
||||
|
||||
Sets the property for the validator.
|
||||
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
\section{\class{wxPropertyView}}\label{wxpropertyview}
|
||||
|
||||
\overview{wxPropertyView overview}{wxpropertyviewoverview}
|
||||
|
||||
The {\bf wxPropertyView} abstract class is the base class for views
|
||||
of property sheets, acting as intermediaries between properties and
|
||||
actual windows.
|
||||
|
||||
\membersection{wxPropertyView::wxPropertyView}
|
||||
|
||||
\func{void}{wxPropertyView}{\param{long}{ flags = wxPROP\_BUTTON\_DEFAULT}}
|
||||
|
||||
Constructor.
|
||||
|
||||
The {\it flags} argument can be a bit list of the following:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item wxPROP\_BUTTON\_CLOSE
|
||||
\item wxPROP\_BUTTON\_OK
|
||||
\item wxPROP\_BUTTON\_CANCEL
|
||||
\item wxPROP\_BUTTON\_CHECK\_CROSS
|
||||
\item wxPROP\_BUTTON\_HELP
|
||||
\item wxPROP\_DYNAMIC\_VALUE\_FIELD
|
||||
\item wxPROP\_PULLDOWN
|
||||
\end{itemize}
|
||||
|
||||
\membersection{wxPropertyView::\destruct{wxPropertyView}}
|
||||
|
||||
\func{void}{\destruct{wxPropertyView}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxPropertyView::AddRegistry}\label{wxpropertyviewaddregistry}
|
||||
|
||||
\func{void}{AddRegistry}{\param{wxPropertyValidatorRegistry *}{registry}}
|
||||
|
||||
Adds a registry (list of property validators) the view's list of registries, which is initially empty.
|
||||
|
||||
\membersection{wxPropertyView::FindPropertyValidator}\label{wxpropertyviewfindpropertyvalidator}
|
||||
|
||||
\func{wxPropertyValidator *}{FindPropertyValidator}{\param{wxProperty *}{property}}
|
||||
|
||||
Finds the property validator that is most appropriate to this property.
|
||||
|
||||
\membersection{wxPropertyView::GetPropertySheet}\label{wxpropertyviewgetpropertysheet}
|
||||
|
||||
\func{wxPropertySheet *}{GetPropertySheet}{\void}
|
||||
|
||||
Gets the property sheet for this view.
|
||||
|
||||
\membersection{wxPropertyView::GetRegistryList}\label{wxpropertyviewgetregistrylist}
|
||||
|
||||
\func{wxList\&}{GetRegistryList}{\void}
|
||||
|
||||
Returns a reference to the list of property validator registries.
|
||||
|
||||
\membersection{wxPropertyView::OnOk}\label{wxpropertyviewonok}
|
||||
|
||||
\func{void}{OnOk}{\void}
|
||||
|
||||
Virtual function that will be called when the OK button on the physical window is pressed (if it exists).
|
||||
|
||||
\membersection{wxPropertyView::OnCancel}\label{wxpropertyviewoncancel}
|
||||
|
||||
\func{void}{OnCancel}{\void}
|
||||
|
||||
Virtual function that will be called when the Cancel button on the physical window is pressed (if it exists).
|
||||
|
||||
\membersection{wxPropertyView::OnClose}\label{wxpropertyviewonclose}
|
||||
|
||||
\func{Bool}{OnClose}{\void}
|
||||
|
||||
Virtual function that will be called when the physical window is closed. The default implementation returns FALSE.
|
||||
|
||||
\membersection{wxPropertyView::OnHelp}\label{wxpropertyviewonhelp}
|
||||
|
||||
\func{void}{OnHelp}{\void}
|
||||
|
||||
Virtual function that will be called when the Help button on the physical window is pressed (if it exists).
|
||||
|
||||
\membersection{wxPropertyView::OnPropertyChanged}\label{wxpropertyviewonpropertychanged}
|
||||
|
||||
\func{void}{OnPropertyChanged}{\param{wxProperty *}{property}}
|
||||
|
||||
Virtual function called by a view or validator when a property's value changed. Validators
|
||||
must be written correctly for this to be called. You can override this function
|
||||
to respond immediately to property value changes.
|
||||
|
||||
\membersection{wxPropertyView::OnUpdateView}\label{wxpropertyviewonupdateview}
|
||||
|
||||
\func{Bool}{OnUpdateView}{\void}
|
||||
|
||||
Called by the viewed object to update the view. The default implementation just returns
|
||||
FALSE.
|
||||
|
||||
\membersection{wxPropertyView::SetPropertySheet}\label{wxpropertyviewsetpropertysheet}
|
||||
|
||||
\func{void}{SetPropertySheet}{\param{wxPropertySheet *}{sheet}}
|
||||
|
||||
Sets the property sheet for this view.
|
||||
|
||||
\membersection{wxPropertyView::ShowView}\label{wxpropertyviewshowview}
|
||||
|
||||
\func{void}{ShowView}{\param{wxPropertySheet *}{sheet}, \param{wxPanel *}{panel}}
|
||||
|
||||
Associates this view with the given panel, and shows the view.
|
||||
|
||||
Reference in New Issue
Block a user