Whole bunch of minor doc updates from an external patch.
Also documented combobox's EVT_TEXT_ENTER git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@30929 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
88379f1f2e
commit
3980000ca6
@ -47,6 +47,7 @@ wxGTK:
|
||||
- implemented wxTextCtrl::Freeze() and Thaw(). The GtkTextBuffer
|
||||
is not a valid one during frozen state. Get a pointer to it right
|
||||
after wxTextCtrl creation if you really need to. (Mart Raudsepp)
|
||||
-
|
||||
|
||||
wxMac:
|
||||
|
||||
|
@ -1,7 +1,7 @@
|
||||
\section{\class{wxButton}}\label{wxbutton}
|
||||
|
||||
A button is a control that contains a text string,
|
||||
and is one of the commonest elements of a GUI. It may be placed on a
|
||||
and is one of the most common elements of a GUI. It may be placed on a
|
||||
\rtfsp\helpref{dialog box}{wxdialog} or \helpref{panel}{wxpanel}, or indeed
|
||||
almost any other window.
|
||||
|
||||
|
@ -554,7 +554,7 @@ used internally by the HTML classes.
|
||||
|
||||
{\large {\bf XML-based resource system classes}}
|
||||
|
||||
\overview{XML-based resource system overview}{xrcoverview}
|
||||
\overview{XML-based resource system (XRC) overview}{xrcoverview}
|
||||
|
||||
Resources allow your application to create controls and other user interface elements
|
||||
from specifications stored in an XML format.
|
||||
|
@ -116,7 +116,7 @@ Returns true if the clipboard has been opened.
|
||||
|
||||
\func{bool}{IsSupported}{\param{const wxDataFormat\&}{ format}}
|
||||
|
||||
Returns true if the format of the given data object is available on the clipboard.
|
||||
Returns true if there is data which matches the data format of the given data object currently {\bf available} (IsSupported sounds like a misnomer, FIXME: better deprecate this name?) on the clipboard.
|
||||
|
||||
\membersection{wxClipboard::Open}\label{wxclipboardopen}
|
||||
|
||||
|
@ -40,6 +40,8 @@ when an item on the list is selected. Note that calling
|
||||
\helpref{GetValue}{wxcomboboxgetvalue} returns the new value of selection.}
|
||||
\twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED event,
|
||||
when the combobox text changes.}
|
||||
\twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_ENTER event,
|
||||
when <RETURN> is pressed in the combobox.}
|
||||
\end{twocollist}
|
||||
|
||||
\wxheading{See also}
|
||||
|
@ -395,7 +395,7 @@ your application's responsibility to ensure that there is no newline or
|
||||
other illegal characters in a value, before writing that value to the file.}
|
||||
|
||||
\docparam{conv}{This parameter is only used by wxFileConfig when compiled
|
||||
in Unicode mode. It specifies the encoding in what the configuration file
|
||||
in Unicode mode. It specifies the encoding in which the configuration file
|
||||
is written.}
|
||||
|
||||
|
||||
|
@ -47,7 +47,7 @@ which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple}
|
||||
\helpref{wxDataObjectSimple}{wxdataobjectsimple} is
|
||||
the simplest wxDataObject possible and only holds data in a single format (such
|
||||
as HTML or text) and \helpref{wxDataObjectComposite}{wxdataobjectcomposite} is
|
||||
the simplest way to implement a wxDataObject which that does support multiple formats
|
||||
the simplest way to implement a wxDataObject that does support multiple formats
|
||||
because it achieves this by simply holding several wxDataObjectSimple objects.
|
||||
|
||||
So, you have several solutions when you need a wxDataObject class (and you need
|
||||
|
@ -404,7 +404,7 @@ provided. You can construct a wxDateTime object from a
|
||||
\membersection{Time zone and DST support}\label{datetimedstzone}
|
||||
|
||||
Please see the \helpref{time zone overview}{tdatetimezones} for more
|
||||
information about time zones. ormally, these functions should be rarely used.
|
||||
information about time zones. Normally, these functions should be rarely used.
|
||||
|
||||
\helpref{ToTimezone}{wxdatetimetotimezone}\\
|
||||
\helpref{MakeTimezone}{wxdatetimemaketimezone}\\
|
||||
|
@ -1117,9 +1117,9 @@ Starts a document page (only relevant when outputting to a printer).
|
||||
|
||||
\section{\class{wxDCClipper}}\label{wxdcclipper}
|
||||
|
||||
This is a small helper class which sets the specified to its constructor
|
||||
This is a small helper class which sets the specified DC to its constructor
|
||||
clipping region and then automatically destroys it in its destructor. Using
|
||||
it ensures that unwanted clipping region is not left set on the DC.
|
||||
it ensures that an unwanted clipping region is not left set on the DC.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
|
@ -55,7 +55,7 @@ below:
|
||||
}
|
||||
\end{verbatim}
|
||||
|
||||
An application can define an \helpref{wxCloseEvent}{wxcloseevent} handler for
|
||||
An application can define a \helpref{wxCloseEvent}{wxcloseevent} handler for
|
||||
the dialog to respond to system close events.
|
||||
|
||||
\wxheading{Window styles}
|
||||
|
@ -12,7 +12,7 @@
|
||||
\section{\class{wxDataObjectComposite}}\label{wxdataobjectcomposite}
|
||||
|
||||
wxDataObjectComposite is the simplest
|
||||
\helpref{wxDataObject}{wxdataobject} derivation which may be sued to support
|
||||
\helpref{wxDataObject}{wxdataobject} derivation which may be used to support
|
||||
multiple formats. It contains several
|
||||
\helpref{wxDataObjectSimple}{wxdataobjectsimple} objects and supports any
|
||||
format supported by at least one of them. Only one of these data objects is
|
||||
|
@ -289,37 +289,43 @@ from \helpref{Initialize}{wxdocmanagerinitialize}.
|
||||
|
||||
\membersection{wxDocManager::OnFileClose}\label{wxdocmanageronfileclose}
|
||||
|
||||
\func{void}{OnFileClose}{\void}
|
||||
\func{void}{OnFileClose}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
Closes and deletes the currently active document.
|
||||
|
||||
\membersection{wxDocManager::OnFileCloseAll}\label{wxdocmanageronfilecloseall}
|
||||
|
||||
\func{void}{OnFileCloseAll}{\void}
|
||||
\func{void}{OnFileCloseAll}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
Closes and deletes all the currently opened documents.
|
||||
|
||||
\membersection{wxDocManager::OnFileNew}\label{wxdocmanageronfilenew}
|
||||
|
||||
\func{void}{OnFileNew}{\void}
|
||||
\func{void}{OnFileNew}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
Creates a document from a list of templates (if more than one template).
|
||||
|
||||
\membersection{wxDocManager::OnFileOpen}\label{wxdocmanageronfileopen}
|
||||
|
||||
\func{void}{OnFileOpen}{\void}
|
||||
\func{void}{OnFileOpen}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
Creates a new document and reads in the selected file.
|
||||
|
||||
\membersection{wxDocManager::OnFileRevert}\label{wxdocmanageronfilerevert}
|
||||
|
||||
\func{void}{OnFileRevert}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
Reverts the current document by calling wxDocument::Revert for the current document.
|
||||
|
||||
\membersection{wxDocManager::OnFileSave}\label{wxdocmanageronfilesave}
|
||||
|
||||
\func{void}{OnFileSave}{\void}
|
||||
\func{void}{OnFileSave}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
Saves the current document by calling wxDocument::Save for the current document.
|
||||
|
||||
\membersection{wxDocManager::OnFileSaveAs}\label{wxdocmanageronfilesaveas}
|
||||
|
||||
\func{void}{OnFileSaveAs}{\void}
|
||||
\func{void}{OnFileSaveAs}{\param{wxCommandEvent\& }{event}}
|
||||
|
||||
Calls wxDocument::SaveAs for the current document.
|
||||
|
||||
|
@ -23,7 +23,8 @@ enum wxDragResult
|
||||
wxDragError, // error prevented the d&d operation from completing
|
||||
wxDragNone, // drag target didn't accept the data
|
||||
wxDragCopy, // the data was successfully copied
|
||||
wxDragMove, // the data was successfully moved
|
||||
wxDragMove, // the data was successfully moved (MSW only)
|
||||
wxDragLink, // operation is a drag-link
|
||||
wxDragCancel // the operation was cancelled by user (not an error)
|
||||
};
|
||||
\end{verbatim}
|
||||
@ -92,7 +93,13 @@ operation}.
|
||||
\wxheading{Return value}
|
||||
|
||||
Returns the operation requested by the user, may be {\tt wxDragCopy}, {\tt
|
||||
wxDragMove}, {\tt wxDragCancel} or {\tt wxDragNone} if an error occured.
|
||||
wxDragMove}, {\tt wxDragLink}, {\tt wxDragCancel} or {\tt wxDragNone} if an error occured.
|
||||
|
||||
\membersection{wxDropSource::GetDataObject}\label{wxdropsourcegetdataobject}
|
||||
|
||||
\func{wxDataObject *}{GetDataObject}{\void}
|
||||
|
||||
Returns the wxDataObject object that has been assigned previously.
|
||||
|
||||
\membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
|
||||
|
||||
@ -104,7 +111,7 @@ slow.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove and wxDragNone. }
|
||||
\docparam{effect}{The effect to implement. One of {\tt wxDragCopy}, {\tt wxDragMove}, {\tt wxDragLink} and {\tt wxDragNone}. }
|
||||
|
||||
\docparam{scrolling}{true if the window is scrolling. MSW only. }
|
||||
|
||||
@ -113,3 +120,15 @@ slow.
|
||||
Return false if you want default feedback, or true if you implement your own
|
||||
feedback. The return values is ignored under GTK.
|
||||
|
||||
\membersection{wxDropSource::SetCursor}\label{wxdropsourcesetcursor}
|
||||
|
||||
\func{void}{SetCursor}{\param{wxDragResult }{res}, \param{const wxCursor\& }{cursor}}
|
||||
|
||||
Set the icon to use for a certain drag result.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{res}{The drag result to set the icon for. }
|
||||
|
||||
\docparam{cursor}{The ion to show when this drag result occurs. }
|
||||
|
||||
|
@ -32,7 +32,8 @@ enum wxDragResult
|
||||
wxDragError, // error prevented the d&d operation from completing
|
||||
wxDragNone, // drag target didn't accept the data
|
||||
wxDragCopy, // the data was successfully copied
|
||||
wxDragMove, // the data was successfully moved
|
||||
wxDragMove, // the data was successfully moved (MSW only)
|
||||
wxDragLink, // operation is a drag-link
|
||||
wxDragCancel // the operation was cancelled by user (not an error)
|
||||
};
|
||||
\end{verbatim}
|
||||
|
@ -10,7 +10,7 @@ class.
|
||||
{\bf Warning:} Under all non-Windows platforms this class is currently
|
||||
"input-only", i.e. you can receive the files from another application, but
|
||||
copying (or dragging) file(s) from a wxWidgets application is not currently
|
||||
supported.
|
||||
supported. PS: GTK2 should work as well.
|
||||
|
||||
\wxheading{Virtual functions to override}
|
||||
|
||||
|
@ -189,8 +189,8 @@ the static \helpref{New}{wxfontnew} method must be used.}
|
||||
|
||||
\docparam{underline}{The value can be true or false. At present this has an effect on Windows and Motif 2.x only.}
|
||||
|
||||
\docparam{faceName}{An optional string specifying the actual typeface to be used. If the empty string,
|
||||
a default typeface will chosen based on the family.}
|
||||
\docparam{faceName}{An optional string specifying the actual typeface to be used. If it is an empty string,
|
||||
a default typeface will be chosen based on the family.}
|
||||
|
||||
\docparam{encoding}{An encoding which may be one of
|
||||
\twocolwidtha{5cm}
|
||||
|
@ -1,6 +1,6 @@
|
||||
\subsection{wxHTML quick start}\label{wxhtmlquickstart}
|
||||
|
||||
\wxheading{Displaying HMTL}
|
||||
\wxheading{Displaying HTML}
|
||||
|
||||
First of all, you must include <wx/wxhtml.h>.
|
||||
|
||||
@ -28,9 +28,9 @@ See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
|
||||
\wxheading{Setting up wxHtmlWindow}
|
||||
|
||||
Because wxHtmlWindow is derived from wxScrolledWindow and not from
|
||||
wxFrame, it doesn't have visible frame. But the user usually want to see
|
||||
the title of HTML page displayed somewhere and frame's titlebar is
|
||||
ideal place for it.
|
||||
wxFrame, it doesn't have visible frame. But the user usually wants to see
|
||||
the title of HTML page displayed somewhere and the frame's titlebar is
|
||||
the ideal place for it.
|
||||
|
||||
wxHtmlWindow provides 2 methods in order to handle this:
|
||||
\helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe} and
|
||||
@ -43,8 +43,8 @@ See the example:
|
||||
html -> SetRelatedStatusBar(0);
|
||||
\end{verbatim}
|
||||
|
||||
The first command associates html object with it is parent frame
|
||||
(this points to wxFrame object there) and sets format of title.
|
||||
The first command associates the HTML object with its parent frame
|
||||
(this points to wxFrame object there) and sets the format of the title.
|
||||
Page title "Hello, world!" will be displayed as "HTML : Hello, world!"
|
||||
in this example.
|
||||
|
||||
|
@ -182,6 +182,8 @@ selected items as a list.}
|
||||
|
||||
\func{void}{InsertItems}{\param{int}{ nItems}, \param{const wxString}{ *items}, \param{int}{ pos}}
|
||||
|
||||
\func{void}{InsertItems}{\param{const wxArrayString\&}{ nItems}, \param{int}{ pos}}
|
||||
|
||||
Insert the given number of strings before the specified position.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
@ -124,7 +124,7 @@ Meaningful only for column headers in report mode. Returns the column width.
|
||||
\func{void}{SetAlign}{\param{wxListColumnFormat }{align}}
|
||||
|
||||
Sets the alignment for the item. See also
|
||||
\helpref{wxListItem::SetAlign}{wxlistitemsetalign}
|
||||
\helpref{wxListItem::GetAlign}{wxlistitemgetalign}
|
||||
|
||||
\membersection{wxListItem::SetBackgroundColour}\label{wxlistitemsetbackgroundcolour}
|
||||
|
||||
|
@ -334,7 +334,7 @@ context it returns a 2-element list {\tt ( item, submenu )}}
|
||||
|
||||
\docparam{id}{Menu item identifier.}
|
||||
|
||||
\docparam{menu}{If the pointer is not NULL, it will be filled with the items
|
||||
\docparam{menu}{If the pointer is not NULL, it will be filled with the item's
|
||||
parent menu (if the item was found)}
|
||||
|
||||
\wxheading{Return value}
|
||||
@ -432,7 +432,7 @@ menubar.
|
||||
\param{wxItemKind}{ kind = wxITEM\_NORMAL}}
|
||||
|
||||
Inserts the given {\it item} before the position {\it pos}. Inserting the item
|
||||
at the position \helpref{GetMenuItemCount}{wxmenugetmenuitemcount} is the same
|
||||
at position \helpref{GetMenuItemCount}{wxmenugetmenuitemcount} is the same
|
||||
as appending it.
|
||||
|
||||
\wxheading{See also}
|
||||
@ -519,20 +519,20 @@ true if the menu item is enabled, false otherwise.
|
||||
\param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
|
||||
\param{wxItemKind}{ kind = wxITEM\_NORMAL}}
|
||||
|
||||
Inserts the given {\it item} at the position $0$, i.e. before all the other
|
||||
Inserts the given {\it item} at position $0$, i.e. before all the other
|
||||
existing items.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxMenu::Append}{wxmenuappend},\rtfsp
|
||||
\helpref{wxMenu::Inserts}{wxmenuinsert}
|
||||
\helpref{wxMenu::Insert}{wxmenuinsert}
|
||||
|
||||
\membersection{wxMenu::PrependCheckItem}\label{wxmenuprependcheckitem}
|
||||
|
||||
\func{wxMenuItem*}{PrependCheckItem}{\param{int}{ id},\rtfsp
|
||||
\param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
|
||||
|
||||
Inserts a checkable item at the position $0$.
|
||||
Inserts a checkable item at position $0$.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
@ -544,7 +544,7 @@ Inserts a checkable item at the position $0$.
|
||||
\func{wxMenuItem*}{PrependRadioItem}{\param{int}{ id},\rtfsp
|
||||
\param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
|
||||
|
||||
Inserts a radio item at the position $0$.
|
||||
Inserts a radio item at position $0$.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
@ -555,7 +555,7 @@ Inserts a radio item at the position $0$.
|
||||
|
||||
\func{wxMenuItem*}{PrependSeparator}{\param{size\_t }{pos}}
|
||||
|
||||
Inserts a separator at the position $0$.
|
||||
Inserts a separator at position $0$.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
@ -989,7 +989,7 @@ Replaces the menu at the given position with another one.
|
||||
|
||||
\wxheading{Return value}
|
||||
|
||||
The menu which was previously at the position {\it pos}. The caller is
|
||||
The menu which was previously at position {\it pos}. The caller is
|
||||
responsible for deleting it.
|
||||
|
||||
\wxheading{See also}
|
||||
|
@ -59,7 +59,7 @@ The relevant menu identifier.
|
||||
|
||||
\constfunc{wxMenu *}{GetMenu}{\void}
|
||||
|
||||
Returns the menu which is being opened or closed. This method should be only
|
||||
Returns the menu which is being opened or closed. This method should only be
|
||||
used with the \texttt{OPEN} and \texttt{CLOSE} events.
|
||||
|
||||
|
||||
@ -78,6 +78,6 @@ only used with the {\tt HIGHLIGHT} events.
|
||||
Returns {\tt true} if the menu which is being opened or closed is a popup menu,
|
||||
{\tt false} if it is a normal one.
|
||||
|
||||
This method should be only used with the {\tt OPEN} and {\tt CLOSE} events.
|
||||
This method should only be used with the {\tt OPEN} and {\tt CLOSE} events.
|
||||
|
||||
|
||||
|
@ -27,7 +27,7 @@ wxOwnerDrawn (Windows only)\\
|
||||
|
||||
\func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = wxID\_SEPARATOR},
|
||||
\param{const wxString\& }{text = ""}, \param{const wxString\& }{helpString = ""},
|
||||
\param{wxItemKind }{kind = wxITEM\_NORMAL}, \param{wxMenu*}{ subMenu = NULL}, }
|
||||
\param{wxItemKind }{kind = wxITEM\_NORMAL}, \param{wxMenu*}{ subMenu = NULL}}
|
||||
|
||||
Constructs a wxMenuItem object.
|
||||
|
||||
@ -58,7 +58,7 @@ Destructor.
|
||||
|
||||
\membersection{wxMenuItem::Check}\label{wxmenuitemcheck}
|
||||
|
||||
\func{void}{Check}{\param{bool}{ check}}
|
||||
\func{void}{Check}{\param{bool}{ check = true}}
|
||||
|
||||
Checks or unchecks the menu item.
|
||||
|
||||
@ -67,7 +67,7 @@ Note that this only works when the item is already appended to a menu.
|
||||
|
||||
\membersection{wxMenuItem::Enable}\label{wxmenuitemenable}
|
||||
|
||||
\func{void}{Enable}{\param{bool}{ enable}}
|
||||
\func{void}{Enable}{\param{bool}{ enable = true}}
|
||||
|
||||
Enables or disables the menu item.
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
This class represents the events generated by a notebook control: currently,
|
||||
there are two of them. The PAGE\_CHANGING event is sent before the current
|
||||
page is changed. It allows to the program to examine the current page (which
|
||||
page is changed. It allows the program to examine the current page (which
|
||||
can be retrieved with
|
||||
\helpref{GetOldSelection()}{wxnotebookeventgetoldselection}) and to veto the page
|
||||
change by calling \helpref{Veto()}{wxnotifyeventveto} if, for example, the
|
||||
|
@ -75,7 +75,7 @@ Constructor, creating and showing a scrollbar.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{parent}{Parent window. Must not be NULL.}
|
||||
\docparam{parent}{Parent window. Must be non-NULL.}
|
||||
|
||||
\docparam{id}{Window identifier. A value of -1 indicates a default value.}
|
||||
|
||||
|
@ -1,12 +1,12 @@
|
||||
\section{Changes since 2.4.x}\label{changes}
|
||||
|
||||
Listed here are the depreciated and incompatable changes made to wxWidgets.
|
||||
Listed here are the depreciated and incompatible changes made to wxWidgets.
|
||||
|
||||
For other changes (such as additional features, bug fixes, etc.) see the changes.txt file located in the docs directory of your wxWidgets directory.
|
||||
|
||||
|
||||
|
||||
\subsection{Incompatable changes since 2.4.x}\label{incompatiblesince24}
|
||||
\subsection{Incompatible changes since 2.4.x}\label{incompatiblesince24}
|
||||
|
||||
\subsubsection{New window repainting behaviour}\label{newwindowrepainting}
|
||||
|
||||
@ -127,7 +127,7 @@ sizer->Add(win);
|
||||
|
||||
|
||||
|
||||
\subsubsection{Less drastic incompatable changes since 2.4.x}\label{24incompatiblelessdrastic}
|
||||
\subsubsection{Less drastic incompatible changes since 2.4.x}\label{24incompatiblelessdrastic}
|
||||
|
||||
- no initialization/cleanup can be done in \helpref{wxApp}{wxappctor}/\helpref{~wxApp}{wxappdtor} because they are
|
||||
now called much earlier/later than before; please move any exiting code
|
||||
|
@ -622,7 +622,7 @@ if SQL logging is turned on for the classes.
|
||||
|
||||
To use the table and the definitions that are now set up, we must first
|
||||
define what data we want the datasource to collect in to a result set, tell
|
||||
it where to get the data from, and in what sequence we want the data returned.
|
||||
it where to get the data from, and in which sequence we want the data returned.
|
||||
|
||||
\begin{verbatim}
|
||||
// the WHERE clause limits/specifies which rows in the table
|
||||
|
@ -387,7 +387,7 @@ to make these functions reentrant (i.e. allow more than one
|
||||
enumeration on one and the same object simultaneously). The cookie passed to
|
||||
GetFirstChild and GetNextChild should be the same variable.
|
||||
|
||||
Returns an invalid tree item if there are no further children.
|
||||
Returns an invalid tree item (i.e. IsOk() returns {\tt false}) if there are no further children.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
\section{Run time class information overview}\label{runtimeclassoverview}
|
||||
\section{Runtime class information (aka RTTI) overview}\label{runtimeclassoverview}
|
||||
|
||||
Classes: \helpref{wxObject}{wxobject}, \helpref{wxClassInfo}{wxclassinfo}.
|
||||
|
||||
@ -10,7 +10,7 @@ storage hard to implement.
|
||||
|
||||
Most C++ GUI frameworks overcome these limitations by means of a set of
|
||||
macros and functions and wxWidgets is no exception. As it originated before the
|
||||
addition of RTTI to standard C++ and as support for it is still missing from
|
||||
addition of RTTI to the C++ standard and as support for it is still missing from
|
||||
some (albeit old) compilers, wxWidgets doesn't (yet) use it, but provides its
|
||||
own macro-based RTTI system.
|
||||
|
||||
@ -54,7 +54,7 @@ can simply call \helpref{wxClassInfo::CreateObject}{wxclassinfocreateobject}.
|
||||
|
||||
\subsection{wxClassInfo}\label{wxclassinfooverview}
|
||||
|
||||
\overview{Run time class information overview}{runtimeclassoverview}
|
||||
\overview{Runtime class information (aka RTTI) overview}{runtimeclassoverview}
|
||||
|
||||
Class: \helpref{wxClassInfo}{wxclassinfo}
|
||||
|
||||
|
@ -41,7 +41,7 @@ the standard font as well as the overall design of Linux/GTK widgets requires mo
|
||||
on Windows, the initial dialog size will automatically be bigger on Linux/GTK than on Windows.
|
||||
|
||||
There are currently five different kinds of sizers available in wxWidgets. Each represents
|
||||
either a certain way to lay out dialog items in a dialog or it fulfils a special task
|
||||
either a certain way to lay out dialog items in a dialog or it fulfills a special task
|
||||
such as wrapping a static box around a dialog item (or another sizer). These sizers will
|
||||
be discussed one by one in the text below. For more detailed information on how to use sizers
|
||||
programmatically, please refer to the section \helpref{Programming with Sizers}{boxsizerprogramming}.
|
||||
@ -171,10 +171,10 @@ For programming information, see \helpref{wxGridSizer}{wxgridsizer}.
|
||||
|
||||
Another two-dimensional sizer derived from
|
||||
wxGridSizer. The width of each column and the height of each row
|
||||
are calculated individually according the minimal requirements
|
||||
are calculated individually according to the minimal requirements
|
||||
from the respectively biggest child. Additionally, columns and
|
||||
rows can be declared to be stretchable if the sizer is assigned
|
||||
a size different from that which it requested. The following sample shows
|
||||
a size different from the one it requested. The following sample shows
|
||||
the same dialog as the one above, but using a flex grid sizer:
|
||||
|
||||
\begin{center}
|
||||
|
@ -8,7 +8,7 @@ Classes: \helpref{wxXmlResource}{wxxmlresource}, \helpref{wxXmlResourceHandler}{
|
||||
The XML-based resource system, known as XRC, allows user interface elements such as
|
||||
dialogs, menu bars and toolbars, to be stored in text files and loaded into
|
||||
the application at run-time. XRC files can also be compiled into binary XRS files or C++
|
||||
code (the former makes it possible to store all resources in since file and the latter
|
||||
code (the former makes it possible to store all resources in a single file and the latter
|
||||
is useful when you want to embed the resources into the executable).
|
||||
|
||||
There are several advantages to using XRC resources.
|
||||
@ -16,7 +16,7 @@ There are several advantages to using XRC resources.
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item Recompiling and linking an application is not necessary if the
|
||||
resources change.
|
||||
\item If you use a dialog designers that generates C++ code, it can be hard
|
||||
\item If you use a dialog designer that generates C++ code, it can be hard
|
||||
to reintegrate this into existing C++ code. Separation of resources and code
|
||||
is a more elegant solution.
|
||||
\item You can choose between different alternative resource files at run time, if necessary.
|
||||
@ -40,7 +40,7 @@ wxFileSystem ZIP handler first with {\tt wxFileSystem::AddHandler(new wxZipFSHan
|
||||
\item call {\tt wxXmlResource::Get()->InitAllHandlers()} from your wxApp::OnInit function,
|
||||
and then call {\tt wxXmlResource::Get()->Load("myfile.xrc")} to load the resource file;
|
||||
\item to create a dialog from a resource, create it using the default constructor, and then
|
||||
load using for example {\tt wxXmlResource::Get()->LoadDialog(\&dlg, this, "dlg1");}
|
||||
load it using for example {\tt wxXmlResource::Get()->LoadDialog(\&dlg, this, "dlg1");}
|
||||
\item set up event tables as usual but use the {\tt XRCID(str)} macro to translate from XRC string names
|
||||
to a suitable integer identifier, for example {\tt EVT\_MENU(XRCID("quit"), MyFrame::OnQuit)}.
|
||||
\end{itemize}
|
||||
@ -97,7 +97,7 @@ For example:
|
||||
|
||||
XRS file is essentially a renamed ZIP archive which means that you can manipulate
|
||||
it with standard ZIP tools. Note that if you are using XRS files, you have
|
||||
to initialize \helpref{wxFileSystem}{wxfilesystem} ZIP handler first! It is a simple
|
||||
to initialize the \helpref{wxFileSystem}{wxfilesystem} ZIP handler first! It is a simple
|
||||
thing to do:
|
||||
|
||||
\begin{verbatim}
|
||||
@ -110,7 +110,7 @@ thing to do:
|
||||
\subsection{Using embedded resources}\label{embeddedresource}
|
||||
|
||||
It is sometimes useful to embed resources in the executable itself instead
|
||||
of loading external file (e.g. when your app is small and consists only of one
|
||||
of loading an external file (e.g. when your app is small and consists only of one
|
||||
exe file). XRC provides means to convert resources into regular C++ file that
|
||||
can be compiled and included in the executable.
|
||||
|
||||
@ -480,7 +480,7 @@ TestWnd::TestWnd(){
|
||||
The generated window class can be used as basis for the full window class. The
|
||||
class members which represent widgets may be accessed by name instead of using
|
||||
{\tt XRCCTRL} every time you wish to reference them (note that they are {\tt protected} class members),
|
||||
though you must still use {\tt XRCID} to refer to widget ids in the event
|
||||
though you must still use {\tt XRCID} to refer to widget IDs in the event
|
||||
table.
|
||||
|
||||
Example:
|
||||
|
@ -1119,17 +1119,6 @@ method:\par
|
||||
Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
|
||||
|
||||
|
||||
\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
|
||||
|
||||
\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
|
||||
|
||||
Returns the built-in scrollbar thumb size.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
|
||||
|
||||
|
||||
\membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
|
||||
|
||||
\func{virtual int}{GetScrollPos}{\param{int }{orientation}}
|
||||
@ -1152,6 +1141,17 @@ Returns the built-in scrollbar range.
|
||||
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
|
||||
|
||||
|
||||
\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
|
||||
|
||||
\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
|
||||
|
||||
Returns the built-in scrollbar thumb size.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
|
||||
|
||||
|
||||
\membersection{wxWindow::GetSize}\label{wxwindowgetsize}
|
||||
|
||||
\constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
|
||||
@ -1313,7 +1313,7 @@ Returns the value previous passed to
|
||||
|
||||
\constfunc{virtual bool}{HasCapture}{\void}
|
||||
|
||||
Returns true if this window has the current mouse capture.
|
||||
Returns {\tt true} if this window has the current mouse capture.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
@ -1322,6 +1322,18 @@ Returns true if this window has the current mouse capture.
|
||||
\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
|
||||
|
||||
|
||||
\membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
|
||||
|
||||
\constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}
|
||||
|
||||
|
||||
Returns {\tt true} if this window has a scroll bar for this orientation.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.}
|
||||
|
||||
|
||||
\membersection{wxWindow::Hide}\label{wxwindowhide}
|
||||
|
||||
\func{bool}{Hide}{\void}
|
||||
@ -2864,6 +2876,21 @@ on creation and should not be modified subsequently.
|
||||
|
||||
|
||||
|
||||
\membersection{wxWindow::SetLabel}\label{wxwindowsetlabel}
|
||||
|
||||
\func{virtual void}{SetLabel}{\param{const wxString\& }{label}}
|
||||
|
||||
Sets the window's label.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{label}{The window label.}
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::GetLabel}{wxwindowgetlabel}
|
||||
|
||||
|
||||
\membersection{wxWindow::SetName}\label{wxwindowsetname}
|
||||
|
||||
\func{virtual void}{SetName}{\param{const wxString\& }{name}}
|
||||
@ -3503,7 +3530,7 @@ Returns {\tt false} if any of the validations failed.
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
|
||||
\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
|
||||
\helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp
|
||||
\helpref{wxValidator}{wxvalidator}
|
||||
|
||||
|
||||
|
@ -659,7 +659,7 @@ This static function returns the string containing the result of calling
|
||||
|
||||
\membersection{wxString::FormatV}\label{wxstringformatv}
|
||||
|
||||
\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{va\_list }{argptr}}
|
||||
\func{static wxString}{FormatV}{\param{const wxChar }{*format}, \param{va\_list }{argptr}}
|
||||
|
||||
This static function returns the string containing the result of calling
|
||||
\helpref{PrintfV}{wxstringprintfv} with the passed parameters on it.
|
||||
@ -1033,7 +1033,7 @@ familiar with C) results.
|
||||
|
||||
\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}}
|
||||
|
||||
Attempts to convert the string to a unsigned integer in base {\it base}.
|
||||
Attempts to convert the string to an unsigned integer in base {\it base}.
|
||||
Returns {\tt true} on success in which case the number is stored in the
|
||||
location pointed to by {\it val} or {\tt false} if the string does not
|
||||
represent a valid number in the given base.
|
||||
|
@ -61,7 +61,7 @@ All makefiles and project are located in build\msw directory.
|
||||
Where compiled files are stored
|
||||
-------------------------------
|
||||
|
||||
After succesful compilation you'll find the libraries in a subdirectory
|
||||
After successful compilation you'll find the libraries in a subdirectory
|
||||
of lib directory named after the compiler and DLL/static settings.
|
||||
A couple of examples:
|
||||
|
||||
|
@ -58,11 +58,11 @@ and use than MFC and other frameworks.
|
||||
|
||||
As well as comprehensive support for the usual widgets, advanced
|
||||
features include: HTML viewing/printing, wxImage class providing
|
||||
handlers for eading and writing many image types, resizeable panels
|
||||
handlers for reading and writing many image types, resizeable panels
|
||||
and dialogs on all platforms, document/view, OpenGL support,
|
||||
HTML-based and context-sensitive help, wizards, drag and drop,
|
||||
a grid class, ODBC support, threads, sockets, container classes,
|
||||
a styled text control, and much more. An 1800-page reference manual
|
||||
a styled text control, and much more. A 1800-page reference manual
|
||||
is provided in HTML, MS HTML Help, WinHelp, wxWidgets Help and PDF
|
||||
formats, and there are over 80 samples and demos.
|
||||
|
||||
|
@ -31,7 +31,7 @@ comp.windows.x
|
||||
comp.windows.x.announce
|
||||
comp.windows.x.motif
|
||||
|
||||
Note: submissions to comp.windows.linux.announce must be
|
||||
Note: submissions to comp.os.linux.announce must be
|
||||
sent to cola@stump.algebra.com, with short descr
|
||||
of software and location. See http://stump.algebra.com/~cola/
|
||||
NO CROSSPOSTING when sending to this address.
|
||||
|
@ -6,7 +6,7 @@ wxWidgets 2.5.3
|
||||
*** use the official 2.4.x stable series. You are still encouraged
|
||||
*** to try the releases from 2.5.x branch, of course, and unstable
|
||||
*** doesn't mean that they crash all the time -- just that the API
|
||||
*** may change in backwards incompatible way. If this doesn't frighten
|
||||
*** may change in a backwards incompatible way. If this doesn't frighten
|
||||
*** you, do try this release and please let us know what you think!
|
||||
|
||||
Welcome to wxWidgets, a sophisticated cross-platform C++
|
||||
|
Loading…
Reference in New Issue
Block a user