Get/SetTitle only for wxTopLevelWindow.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36074 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -26,6 +26,8 @@ All (GUI):
|
||||
and added SetParentWindow/GetParentWindow.
|
||||
- wxMultiChoiceDialog uses now wxCheckListBox if possible, wxListBox if not.
|
||||
- Added wxBitmapButton::SetHoverBitmap()
|
||||
- Access to titles through Get/SetTitle is available now only for top level
|
||||
windows (wxDialog, wxFrame).
|
||||
|
||||
wxMSW:
|
||||
|
||||
|
@@ -1,3 +1,14 @@
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% Name: dialog.tex
|
||||
%% Purpose: wxDialog documentation
|
||||
%% Author: wxWidgets Team
|
||||
%% Modified by:
|
||||
%% Created:
|
||||
%% RCS-ID: $Id$
|
||||
%% Copyright: (c) wxWidgets Team
|
||||
%% License: wxWindows license
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
\section{\class{wxDialog}}\label{wxdialog}
|
||||
|
||||
A dialog box is a window with a title bar and sometimes a system menu, which
|
||||
@@ -74,7 +85,7 @@ the dialog to respond to system close events.
|
||||
\twocolitem{\windowstyle{wxNO\_3D}}{Under Windows, specifies that the child controls
|
||||
should not have 3D borders unless specified in the control.}
|
||||
\twocolitem{\windowstyle{wxDIALOG\_NO\_PARENT}}{By default, a dialog created
|
||||
with a {\tt NULL} parent window will be given the
|
||||
with a {\tt NULL} parent window will be given the
|
||||
\helpref{application's top level window}{wxappgettopwindow} as parent. Use this
|
||||
style to prevent this from happening and create an orphan dialog. This is not recommended for modal dialogs.}
|
||||
\twocolitem{\windowstyle{wxDIALOG\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
|
||||
@@ -259,13 +270,6 @@ a code to the application.
|
||||
\helpref{wxDialog::EndModal}{wxdialogendmodal}
|
||||
|
||||
|
||||
\membersection{wxDialog::GetTitle}\label{wxdialoggettitle}
|
||||
|
||||
\constfunc{wxString}{GetTitle}{\void}
|
||||
|
||||
Returns the title of the dialog box.
|
||||
|
||||
|
||||
\membersection{wxDialog::GetToolBar}\label{wxdialoggettoolbar}
|
||||
|
||||
\constfunc{wxToolBar*}{GetToolBar}{\void}
|
||||
@@ -441,7 +445,7 @@ See also \helpref{wxIconBundle}{wxiconbundle}.
|
||||
|
||||
\func{void}{SetModal}{\param{const bool}{ flag}}
|
||||
|
||||
{\bf NB:} This function is deprecated and doesn't work for all ports, just use
|
||||
{\bf NB:} This function is deprecated and doesn't work for all ports, just use
|
||||
\helpref{ShowModal}{wxdialogshowmodal} to show a modal dialog instead.
|
||||
|
||||
Allows the programmer to specify whether the dialog box is modal (wxDialog::Show blocks control
|
||||
@@ -473,17 +477,6 @@ a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogend
|
||||
\helpref{wxDialog::EndModal}{wxdialogendmodal}
|
||||
|
||||
|
||||
\membersection{wxDialog::SetTitle}\label{wxdialogsettitle}
|
||||
|
||||
\func{void}{SetTitle}{\param{const wxString\& }{ title}}
|
||||
|
||||
Sets the title of the dialog box.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{title}{The dialog box title.}
|
||||
|
||||
|
||||
\membersection{wxDialog::Show}\label{wxdialogshow}
|
||||
|
||||
\func{bool}{Show}{\param{const bool}{ show}}
|
||||
@@ -517,4 +510,3 @@ The return value is the value set with \helpref{wxDialog::SetReturnCode}{wxdialo
|
||||
\helpref{wxDialog::EndModal}{wxdialogendmodal},\rtfsp
|
||||
\helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp
|
||||
\helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}
|
||||
|
||||
|
@@ -11,7 +11,7 @@
|
||||
|
||||
\section{\class{wxTopLevelWindow}}\label{wxtoplevelwindow}
|
||||
|
||||
wxTopLevelWindow is a common base class for \helpref{wxDialog}{wxdialog} and
|
||||
wxTopLevelWindow is a common base class for \helpref{wxDialog}{wxdialog} and
|
||||
\helpref{wxFrame}{wxframe}. It is an abstract base class meaning that you never
|
||||
work with objects of this class directly, but all of its methods are also
|
||||
applicable for the two classes above.
|
||||
@@ -47,7 +47,7 @@ been previously set by \helpref{SetIcon}{wxtoplevelwindowseticon}.
|
||||
\constfunc{const wxIconBundle\&}{GetIcons}{\void}
|
||||
|
||||
Returns all icons associated with the window, there will be none of them if
|
||||
neither \helpref{SetIcon}{wxtoplevelwindowseticon} nor
|
||||
neither \helpref{SetIcon}{wxtoplevelwindowseticon} nor
|
||||
\helpref{SetIcons}{wxtoplevelwindowseticons} had been called before.
|
||||
|
||||
Use \helpref{GetIcon}{wxtoplevelwindowgeticon} to get the main icon of the
|
||||
@@ -64,7 +64,9 @@ window.
|
||||
|
||||
Gets a string containing the window title.
|
||||
|
||||
See \helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}.
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}
|
||||
|
||||
|
||||
\membersection{wxTopLevelWindow::IsActive}\label{wxtoplevelwindowisactive}
|
||||
@@ -237,7 +239,7 @@ If the platform supports it, sets the shape of the window to that
|
||||
depicted by {\it region}. The system will not display or
|
||||
respond to any mouse event for the pixels that lie outside of the
|
||||
region. To reset the window to the normal rectangular shape simply
|
||||
call {\it SetShape} again with an empty region. Returns TRUE if the
|
||||
call {\it SetShape} again with an empty region. Returns true if the
|
||||
operation is successful.
|
||||
|
||||
|
||||
@@ -282,4 +284,3 @@ Note that showing a window full screen also actually
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxTopLevelWindow::IsFullScreen}{wxtoplevelwindowisfullscreen}
|
||||
|
||||
|
@@ -3,7 +3,7 @@
|
||||
%% Purpose: wxWindow documentation
|
||||
%% Author: wxWidgets Team
|
||||
%% Modified by:
|
||||
%% Created:
|
||||
%% Created:
|
||||
%% RCS-ID: $Id$
|
||||
%% Copyright: (c) wxWidgets Team
|
||||
%% License: wxWindows license
|
||||
@@ -140,11 +140,11 @@ Constructs a window, which can be a child of a frame, dialog or any other non-co
|
||||
|
||||
\docparam{id}{Window identifier. If -1, will automatically create an identifier.}
|
||||
|
||||
\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets
|
||||
\docparam{pos}{Window position. wxDefaultPosition indicates that wxWidgets
|
||||
should generate a default position for the window. If using the wxWindow class directly, supply
|
||||
an actual position.}
|
||||
|
||||
\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets
|
||||
\docparam{size}{Window size. wxDefaultSize indicates that wxWidgets
|
||||
should generate a default size for the window. If no suitable size can be found, the
|
||||
window will be sized to 20x20 pixels so that the window is visible but obviously not
|
||||
correctly sized. }
|
||||
@@ -1250,17 +1250,6 @@ implements the following methods:\par
|
||||
{\tt ( x, y, descent, externalLeading )}.}
|
||||
|
||||
|
||||
\membersection{wxWindow::GetTitle}\label{wxwindowgettitle}
|
||||
|
||||
\func{virtual wxString}{GetTitle}{\void}
|
||||
|
||||
Gets the window's title. Applicable only to frames and dialogs.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::SetTitle}{wxwindowsettitle}
|
||||
|
||||
|
||||
\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
|
||||
|
||||
\constfunc{wxToolTip*}{GetToolTip}{\void}
|
||||
@@ -1541,7 +1530,7 @@ wxWindow::Move function, which is defined in the base wxWindow class
|
||||
as the call:
|
||||
|
||||
\begin{verbatim}
|
||||
SetSize(x, y, -1, -1, wxSIZE_USE_EXISTING);
|
||||
SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING);
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{See also}
|
||||
@@ -2236,7 +2225,7 @@ In current version of wxWidgets this works both for manage and child windows.
|
||||
Causes this window, and all of its children recursively (except under wxGTK1
|
||||
where this is not implemented), to be repainted. Note that repainting doesn't
|
||||
happen immediately but only during the next event loop iteration, if you need
|
||||
to update the window immediately you should use \helpref{Update}{wxwindowupdate}
|
||||
to update the window immediately you should use \helpref{Update}{wxwindowupdate}
|
||||
instead.
|
||||
|
||||
\wxheading{Parameters}
|
||||
@@ -2454,7 +2443,7 @@ parameter)}
|
||||
|
||||
\wxheading{Remarks}
|
||||
|
||||
Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow}
|
||||
Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow}
|
||||
instead of using this function directly.
|
||||
|
||||
|
||||
@@ -3123,16 +3112,16 @@ Sets the size of the window in pixels.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{x}{Required x position in pixels, or -1 to indicate that the existing
|
||||
\docparam{x}{Required x position in pixels, or wxDefaultCoord to indicate that the existing
|
||||
value should be used.}
|
||||
|
||||
\docparam{y}{Required y position in pixels, or -1 to indicate that the existing
|
||||
\docparam{y}{Required y position in pixels, or wxDefaultCoord to indicate that the existing
|
||||
value should be used.}
|
||||
|
||||
\docparam{width}{Required width in pixels, or -1 to indicate that the existing
|
||||
\docparam{width}{Required width in pixels, or wxDefaultCoord to indicate that the existing
|
||||
value should be used.}
|
||||
|
||||
\docparam{height}{Required height position in pixels, or -1 to indicate that the existing
|
||||
\docparam{height}{Required height position in pixels, or wxDefaultCoord to indicate that the existing
|
||||
value should be used.}
|
||||
|
||||
\docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.}
|
||||
@@ -3141,15 +3130,15 @@ value should be used.}
|
||||
|
||||
\docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
|
||||
|
||||
{\bf wxSIZE\_AUTO\_WIDTH}: a $-1$ width value is taken to indicate
|
||||
{\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
|
||||
a wxWidgets-supplied default width.\\
|
||||
{\bf wxSIZE\_AUTO\_HEIGHT}: a $-1$ height value is taken to indicate
|
||||
{\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate
|
||||
a wxWidgets-supplied default width.\\
|
||||
{\bf wxSIZE\_AUTO}: -1 size values are taken to indicate
|
||||
{\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate
|
||||
a wxWidgets-supplied default size.\\
|
||||
{\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
|
||||
if -1 values are supplied.\\
|
||||
{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of $-1$ and less to be interpreted
|
||||
if $wxDefaultCoord$ values are supplied.\\
|
||||
{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow negative dimensions (ie. value of $wxDefaultCoord$) to be interpreted
|
||||
as real dimensions, not default values.
|
||||
{\bf wxSIZE\_FORCE}: normally, if the position and the size of the window are
|
||||
already the same as the parameters of this function, nothing is done. but with
|
||||
@@ -3163,7 +3152,7 @@ The second form is a convenience for calling the first form with default
|
||||
x and y parameters, and must be used with non-default width and height values.
|
||||
|
||||
The first form sets the position and optionally size, of the window.
|
||||
Parameters may be -1 to indicate either that a default should be supplied
|
||||
Parameters may be $wxDefaultCoord$ to indicate either that a default should be supplied
|
||||
by wxWidgets, or that the current value of the dimension should be used.
|
||||
|
||||
\wxheading{See also}
|
||||
@@ -3275,21 +3264,6 @@ Dialogs, notebook pages and the status bar have this flag set to true
|
||||
by default so that the default look and feel is simulated best.
|
||||
|
||||
|
||||
\membersection{wxWindow::SetTitle}\label{wxwindowsettitle}
|
||||
|
||||
\func{virtual void}{SetTitle}{\param{const wxString\& }{title}}
|
||||
|
||||
Sets the window's title. Applicable only to frames and dialogs.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{title}{The window's title.}
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxWindow::GetTitle}{wxwindowgettitle}
|
||||
|
||||
|
||||
\membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
|
||||
|
||||
\func{void}{SetToolTip}{\param{const wxString\& }{tip}}
|
||||
@@ -3593,4 +3567,3 @@ Interface Guidelines forbid moving the mouse cursor programmatically.
|
||||
\docparam{x}{The new x position for the cursor.}
|
||||
|
||||
\docparam{y}{The new y position for the cursor.}
|
||||
|
||||
|
Reference in New Issue
Block a user