Mirrors_UI_SDK/wxWidgets
1
0
Fork 0
mirror of https://github.com/wxWidgets/wxWidgets.git synced 2026-09-20 21:08:24 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

other s*h interface revisions

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56089 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-05 11:24:00 +00:00
parent 95645cce6e
commit e725ba4fc2
11 changed files with 636 additions and 491 deletions
Download Patch File Download Diff File Expand all files Collapse all files
interface/wx/sizer.h
+234 -197
View File
File diff suppressed because it is too large Load Diff
interface/wx/slider.h
+3 -1
View File
@@ -132,6 +132,8 @@ public:
Minimum slider position.
@param maxValue
Maximum slider position.
@param pos
Window position. If wxDefaultPosition is specified then a default position is chosen.
@param size
Window size. If wxDefaultSize is specified then a default size is chosen.
@param style
@@ -145,7 +147,7 @@ public:
*/
wxSlider(wxWindow* parent, wxWindowID id, int value,
int minValue, int maxValue,
const wxPoint& point = wxDefaultPosition,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxSL_HORIZONTAL,
const wxValidator& validator = wxDefaultValidator,
interface/wx/snglinst.h
+36 -23
View File
@@ -10,14 +10,15 @@
@class wxSingleInstanceChecker
wxSingleInstanceChecker class allows to check that only a single instance of a
program is running. To do it, you should create an object of this class. As
long as this object is alive, calls to
wxSingleInstanceChecker::IsAnotherRunning from
other processes will return @true.
program is running.
To do it, you should create an object of this class. As long as this object
is alive, calls to wxSingleInstanceChecker::IsAnotherRunning from other
processes will return @true.
As the object should have the life span as big as possible, it makes sense to
create it either as a global or in wxApp::OnInit. For
example:
create it either as a global or in wxApp::OnInit.
For example:
@code
bool MyApp::OnInit()
@@ -47,10 +48,10 @@
}
@endcode
Note using wxGetUserId() to construct the name: this
allows different user to run the application concurrently which is usually the
intended goal. If you don't use the user name in the wxSingleInstanceChecker
name, only one user would be able to run the application at a time.
Note using wxGetUserId() to construct the name: this allows different user
to run the application concurrently which is usually the intended goal.
If you don't use the user name in the wxSingleInstanceChecker name, only
one user would be able to run the application at a time.
This class is implemented for Win32 and Unix platforms (supporting @c fcntl()
system call, but almost all of modern Unix systems do) only.
@@ -62,37 +63,49 @@ class wxSingleInstanceChecker
{
public:
/**
Like Create() but without
error checking.
Default ctor, use Create() after it.
*/
wxSingleInstanceChecker();
/**
Like Create() but without error checking.
*/
wxSingleInstanceChecker(const wxString& name,
const wxString& path = wxEmptyString);
/**
Destructor frees the associated resources.
Note that it is not virtual, this class is not meant to be used polymorphically
Note that it is not virtual, this class is not meant to be used polymorphically.
*/
~wxSingleInstanceChecker();
/**
Initialize the object if it had been created using the default constructor.
Note that you can't call Create() more than once, so calling it if the
@ref wxsingleinstancechecker() "non default ctor"
had been used is an error.
@ref wxSingleInstanceChecker() "non default ctor" had been used is an error.
@param name
must be given and be as unique as possible. It is used as the
Must be given and be as unique as possible. It is used as the
mutex name under Win32 and the lock file name under Unix.
GetAppName() and wxGetUserId()
are commonly used to construct this parameter.
GetAppName() and wxGetUserId() are commonly used to construct
this parameter.
@param path
is optional and is ignored under Win32 and used as the directory to
create the lock file in under Unix (default is
wxGetHomeDir())
The path is optional and is ignored under Win32 and used as the
directory to create the lock file in under Unix
(default is wxGetHomeDir()).
@return Returns @false if initialization failed, it doesn't mean that
another instance is running - use IsAnotherRunning()
to check for it.
another instance is running - use IsAnotherRunning() to check
for it.
@note
One of possible reasons while Create may fail on Unix is that the lock
file used for checking already exists but was not created by the user.
Therefore applications shouldn't treat failure of this function as fatal
condition, because doing so would open them to the possibility of a
Denial of Service attack. Instead, they should alert the user about
the problem and offer to continue execution without checking if
another instance is running.
*/
bool Create(const wxString& name,
const wxString& path = wxEmptyString);
interface/wx/socket.h
+99 -101
View File
@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: socket.h
// Purpose: interface of wxIPV4address
// Purpose: interface of wxIP*address, wxSocket* classes
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -31,10 +31,10 @@ public:
/**
Set the address to hostname, which can be a host name or an IP-style address
in dot notation(<tt>a.b.c.d</tt>)
in dot notation(<tt>a.b.c.d</tt>).
@return @true on success, @false if something goes wrong (invalid hostname or
invalid IP address).
@return @true on success, @false if something goes wrong (invalid
hostname or invalid IP address).
*/
bool Hostname(const wxString& hostname);
@@ -55,7 +55,6 @@ public:
correctly handle multi-homed hosts and avoid other small problems.
@return @true on success, @false if something went wrong.
*/
bool LocalHost();
@@ -63,7 +62,6 @@ public:
Set the port to that corresponding to the specified @a service.
@return @true on success, @false if something goes wrong (invalid @a service).
*/
bool Service(const wxString& service);
@@ -85,6 +83,8 @@ public:
/**
@class wxSocketServer
@todo describe me.
@library{wxnet}
@category{net}
*/
@@ -100,7 +100,7 @@ public:
@param address
Specifies the local address for the server (e.g. port number).
@param flags
Socket flags (See wxSocketBase::SetFlags())
Socket flags (See wxSocketBase::SetFlags()).
*/
wxSocketServer(const wxSockAddress& address,
wxSocketFlags flags = wxSOCKET_NONE);
@@ -111,12 +111,14 @@ public:
virtual ~wxSocketServer();
/**
Accepts an incoming connection request, and creates a new wxSocketBase object
which represents the server-side of the connection.
Accepts an incoming connection request, and creates a new wxSocketBase
object which represents the server-side of the connection.
If @a wait is @true and there are no pending connections to be
accepted, it will wait for the next incoming connection to
arrive. @b Warning: This will block the GUI.
arrive.
@warning: This method will block the GUI.
If @a wait is @false, it will try to accept a pending connection
if there is one, but it will always return immediately without blocking
@@ -139,10 +141,12 @@ public:
@param socket
Socket to be initialized
@param wait
See Accept() for more info.
@return Returns @true on success, or @false if an error occurred or if the
wait parameter was @false and there were no pending
connections.
@return Returns @true on success, or @false if an error occurred or
if the wait parameter was @false and there were no pending
connections.
@see WaitForAccept(), wxSocketBase::SetNotify(),
wxSocketBase::Notify(), Accept()
@@ -150,10 +154,10 @@ public:
bool AcceptWith(wxSocketBase& socket, bool wait = true);
/**
This function waits for an incoming connection. Use it if you want to call
Accept() or AcceptWith()
with @e wait set to @false, to detect when an incoming connection is waiting
to be accepted.
This function waits for an incoming connection.
Use it if you want to call Accept() or AcceptWith() with @e wait set
to @false, to detect when an incoming connection is waiting to be accepted.
@param seconds
Number of seconds to wait. If -1, it will wait for the default
@@ -216,7 +220,7 @@ public:
/**
Returns the hostname which matches the IP address.
*/
virtual wxString Hostname();
virtual wxString Hostname();
/**
Returns a wxString containing the IP address.
@@ -266,6 +270,8 @@ public:
/**
@class wxSocketClient
@todo describe me.
@library{wxnet}
@category{net}
*/
@@ -289,7 +295,9 @@ public:
Connects to a server using the specified address.
If @a wait is @true, Connect() will wait until the connection
completes. @b Warning: This will block the GUI.
completes.
@warning: This method will block the GUI.
If @a wait is @false, Connect() will try to establish the connection
and return immediately, without blocking the GUI. When used this way,
@@ -304,6 +312,12 @@ public:
If @true, waits for the connection to complete.
@return @true if the connection is established and no error occurs.
If @a wait was true, and Connect() returns @false, an error
occurred and the connection failed.
If @a wait was @false, and Connect() returns @false, you should
still be prepared to handle the completion of this connection request,
either with WaitOnConnect() or by watching wxSOCKET_CONNECTION
and wxSOCKET_LOST events.
@see WaitOnConnect(), wxSocketBase::SetNotify(), wxSocketBase::Notify()
*/
@@ -332,6 +346,12 @@ public:
If @true, waits for the connection to complete.
@return @true if the connection is established and no error occurs.
If @a wait was true, and Connect() returns @false, an error
occurred and the connection failed.
If @a wait was @false, and Connect() returns @false, you should
still be prepared to handle the completion of this connection request,
either with WaitOnConnect() or by watching wxSOCKET_CONNECTION
and wxSOCKET_LOST events.
@see WaitOnConnect(), wxSocketBase::SetNotify(), wxSocketBase::Notify()
*/
@@ -340,36 +360,36 @@ public:
/**
Wait until a connection request completes, or until the specified timeout
elapses. Use this function after issuing a call
to Connect() with @e wait set to @false.
elapses. Use this function after issuing a call to Connect() with
@e wait set to @false.
@param seconds
Number of seconds to wait.
If -1, it will wait for the default timeout,
as set with wxSocketBase::SetTimeout().
@param millisecond
If -1, it will wait for the default timeout, as set with wxSocketBase::SetTimeout().
@param milliseconds
Number of milliseconds to wait.
@return WaitOnConnect() returns @true if the connection request completes.
This does not necessarily mean that the connection was
successfully established; it might also happen that the
connection was refused by the peer. Use wxSocketBase::IsConnected()
to distinguish between these two situations.
@n @n If the timeout elapses, WaitOnConnect() returns @false.
@n @n These semantics allow code like this:
@code
// Issue the connection request
client->Connect(addr, false);
@return
WaitOnConnect() returns @true if the connection request completes.
This does not necessarily mean that the connection was
successfully established; it might also happen that the
connection was refused by the peer. Use wxSocketBase::IsConnected()
to distinguish between these two situations.
@n @n If the timeout elapses, WaitOnConnect() returns @false.
@n @n These semantics allow code like this:
@code
// Issue the connection request
client->Connect(addr, false);
// Wait until the request completes or until we decide to give up
bool waitmore = true;
while ( !client->WaitOnConnect(seconds, millis) && waitmore )
{
// possibly give some feedback to the user,
// and update waitmore as needed.
}
bool success = client->IsConnected();
@endcode
// Wait until the request completes or until we decide to give up
bool waitmore = true;
while ( !client->WaitOnConnect(seconds, millis) && waitmore )
{
// possibly give some feedback to the user,
// and update waitmore as needed.
}
bool success = client->IsConnected();
@endcode
*/
bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
};
@@ -442,8 +462,8 @@ public:
void* GetClientData() const;
/**
Returns the socket object to which this event refers to. This makes
it possible to use the same event handler for different sockets.
Returns the socket object to which this event refers to.
This makes it possible to use the same event handler for different sockets.
*/
wxSocketBase* GetSocket() const;
@@ -473,6 +493,8 @@ enum wxSocketError
/**
@anchor wxSocketEventFlags
wxSocket Event Flags.
A brief note on how to use these events:
@@ -566,15 +588,15 @@ enum wxSocketEventFlags
wxIPaddress::BroadcastAddress().
So:
@b wxSOCKET_NONE will try to read at least SOME data, no matter how much.
@b wxSOCKET_NOWAIT will always return immediately, even if it cannot
read or write ANY data.
@b wxSOCKET_WAITALL will only return when it has read or written ALL
the data.
@b wxSOCKET_BLOCK has nothing to do with the previous flags and
it controls whether the GUI blocks.
@b wxSOCKET_REUSEADDR controls special platform-specific behavior for
reusing local addresses/ports.
- @b wxSOCKET_NONE will try to read at least SOME data, no matter how much.
- @b wxSOCKET_NOWAIT will always return immediately, even if it cannot
read or write ANY data.
- @b wxSOCKET_WAITALL will only return when it has read or written ALL
the data.
- @b wxSOCKET_BLOCK has nothing to do with the previous flags and
it controls whether the GUI blocks.
- @b wxSOCKET_REUSEADDR controls special platform-specific behavior for
reusing local addresses/ports.
*/
enum
{
@@ -593,39 +615,26 @@ enum
/**
@class wxSocketBase
wxSocketBase is the base class for all socket-related objects, and it
defines all basic IO functionality.
@b Note: (Workaround for implementation limitation for wxWidgets up to 2.5.x)
@note
(Workaround for implementation limitation for wxWidgets up to 2.5.x)
If you want to use sockets or derived classes such as wxFTP in a secondary
thread,
call @b wxSocketBase::Initialize() (undocumented) from the main thread before
creating any sockets - in wxApp::OnInit() for example.
thread, call @b wxSocketBase::Initialize() (undocumented) from the main
thread before creating any sockets - in wxApp::OnInit() for example.
See http://wiki.wxwidgets.org/wiki.pl?WxSocket or
http://www.litwindow.com/knowhow/knowhow.html for more details.
@library{wxnet}
@category{net}
<b>wxSocket events:</b>
@beginFlagTable
@flag{wxSOCKET_INPUT}
There is data available for reading.
@flag{wxSOCKET_OUTPUT}
The socket is ready to be written to.
@flag{wxSOCKET_CONNECTION}
Incoming connection request (server), or successful connection
establishment (client).
@flag{wxSOCKET_LOST}
The connection has been closed.
@endFlagTable
@beginEventTable{wxSocketEvent}
@event{EVT_SOCKET(id, func)}
Process a @c wxEVT_SOCKET event.
See @ref wxSocketEventFlags and @ref wxSocketFlags for more info.
@endEventTable
@library{wxnet}
@category{net}
@see wxSocketEvent, wxSocketClient, wxSocketServer, @sample{sockets},
@ref wxSocketFlags, ::wxSocketEventFlags, ::wxSocketError
*/
@@ -728,14 +737,10 @@ public:
cases.
@remarks
For wxSocketClient, IsOk() won't return @true unless the client is connected to a server.
For wxSocketServer, IsOk() will return @true if the server could bind to the specified address
and is already listening for new connections.
IsOk() does not check for IO errors; use Error() instead for that purpose.
*/
bool IsOk() const;
@@ -752,7 +757,6 @@ public:
Returns the last wxSocket error. See @ref wxSocketError .
@note
This function merely returns the last error code,
but it should not be used to determine if an error has occurred (this
is because successful operations do not change the LastError value).
@@ -772,11 +776,9 @@ public:
void RestoreState();
/**
This function saves the current state of the socket in a stack. Socket
state includes flags, as set with SetFlags(),
event mask, as set with SetNotify() and
Notify(), user data, as set with
SetClientData().
This function saves the current state of the socket in a stack.
Socket state includes flags, as set with SetFlags(), event mask, as set
with SetNotify() and Notify(), user data, as set with SetClientData().
Calls to SaveState and RestoreState can be nested.
@see RestoreState()
@@ -803,7 +805,6 @@ public:
the socket, typically to notify the peer that you are closing the connection.
@remarks
Although Close() immediately disables events for the socket, it is possible
that event messages may be waiting in the application's event queue.
The application must therefore be prepared to handle socket event messages even
@@ -837,7 +838,7 @@ public:
socket destruction), so you don't need to use it in these cases.
@see Wait(), WaitForLost(), WaitForRead(), WaitForWrite(),
wxSocketServer::WaitForAccept(), wxSocketClient::WaitOnConnect()
wxSocketServer::WaitForAccept(), wxSocketClient::WaitOnConnect()
*/
void InterruptWait();
@@ -858,9 +859,8 @@ public:
@return Returns a reference to the current object.
@remarks
The exact behaviour of Peek() depends on the combination of flags being used.
For a detailed explanation, see SetFlags()
The exact behaviour of Peek() depends on the combination of flags being used.
For a detailed explanation, see SetFlags()
@see Error(), LastError(), LastCount(), SetFlags()
*/
@@ -879,9 +879,8 @@ public:
@return Returns a reference to the current object.
@remarks
The exact behaviour of Read() depends on the combination of flags being used.
For a detailed explanation, see SetFlags()
The exact behaviour of Read() depends on the combination of flags being used.
For a detailed explanation, see SetFlags()
@see Error(), LastError(), LastCount(),
SetFlags()
@@ -906,11 +905,10 @@ public:
@return Returns a reference to the current object.
@remarks
ReadMsg() will behave as if the @b wxSOCKET_WAITALL flag was always set
and it will always ignore the @b wxSOCKET_NOWAIT flag. The exact behaviour
of ReadMsg() depends on the @b wxSOCKET_BLOCK flag.
For a detailed explanation, see SetFlags().
ReadMsg() will behave as if the @b wxSOCKET_WAITALL flag was always set
and it will always ignore the @b wxSOCKET_NOWAIT flag.
The exact behaviour of ReadMsg() depends on the @b wxSOCKET_BLOCK flag.
For a detailed explanation, see SetFlags().
@see Error(), LastError(), LastCount(), SetFlags(), WriteMsg()
*/
@@ -998,7 +996,7 @@ public:
Number of milliseconds to wait.
@return Returns @true when any of the above conditions is satisfied,
@false if the timeout was reached.
@false if the timeout was reached.
@see InterruptWait(), wxSocketServer::WaitForAccept(),
WaitForLost(), WaitForRead(),
@@ -1018,7 +1016,7 @@ public:
Number of milliseconds to wait.
@return Returns @true if the connection was lost, @false if the timeout
was reached.
was reached.
@see InterruptWait(), Wait()
*/
@@ -1231,7 +1229,7 @@ public:
Number of bytes.
@return Returns a reference to the current object, and the address of
the peer that sent the data on address param.
the peer that sent the data on address param.
@see wxSocketBase::LastError(), wxSocketBase::SetFlags()
*/
interface/wx/sound.h
+26 -32
View File
@@ -10,31 +10,32 @@
@class wxSound
This class represents a short sound (loaded from Windows WAV file), that
can be stored in memory and played. Currently this class is implemented
on Windows and Unix (and uses either
Open Sound System or
Simple DirectMedia Layer).
can be stored in memory and played.
Currently this class is implemented on Windows and Unix (and uses either
Open Sound System or Simple DirectMedia Layer).
@library{wxadv}
@category{FIXME}
@category{misc}
*/
class wxSound : public wxObject
{
public:
//@{
/**
Default ctor.
*/
wxSound();
/**
Constructs a wave object from a file or, under Windows, from a Windows
resource. Call IsOk() to determine whether this
succeeded.
resource. Call IsOk() to determine whether this succeeded.
@param fileName
The filename or Windows resource.
@param isResource
@true if fileName is a resource, @false if it is a filename.
*/
wxSound();
wxSound(const wxString& fileName, bool isResource = false);
//@}
/**
Destroys the wxSound object.
@@ -68,34 +69,27 @@ public:
//@{
/**
Plays the sound file. If another sound is playing, it will be interrupted.
Returns @true on success, @false otherwise. Note that in general it is
possible
to delete the object which is being asynchronously played any time after
calling this function and the sound would continue playing, however this
possible to delete the object which is being asynchronously played any time
after calling this function and the sound would continue playing, however this
currently doesn't work under Windows for sound objects loaded from memory data.
The possible values for @a flags are:
wxSOUND_SYNC
@c Play will block and wait until the sound is
replayed.
wxSOUND_ASYNC
Sound is played asynchronously,
@c Play returns immediately
wxSOUND_ASYNC | wxSOUND_LOOP
Sound is played asynchronously
and loops until another sound is played,
Stop() is called or the program terminates.
- wxSOUND_SYNC: @c Play will block and wait until the sound is replayed.
- wxSOUND_ASYNC: Sound is played asynchronously, @c Play returns immediately.
- wxSOUND_ASYNC|wxSOUND_LOOP: Sound is played asynchronously and loops
until another sound is played, Stop() is
called or the program terminates.
The static form is shorthand for this code:
@code
wxSound(filename).Play(flags);
@endcode
*/
bool Play(unsigned flags = wxSOUND_ASYNC);
const static bool Play(const wxString& filename,
unsigned flags = wxSOUND_ASYNC);
bool Play(unsigned flags = wxSOUND_ASYNC) const;
static bool Play(const wxString& filename,
unsigned flags = wxSOUND_ASYNC);
//@}
/**
interface/wx/spinbutt.h
+43 -17
View File
@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: spinbutt.h
// Purpose: interface of wxSpinEvent
// Purpose: interface of wxSpinEvent, wxSpinButton
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -9,8 +9,20 @@
/**
@class wxSpinEvent
This event class is used for the events generated by
wxSpinButton and wxSpinCtrl.
This event class is used for the events generated by wxSpinButton and wxSpinCtrl.
@beginEventTable{wxSpinEvent}
@event{EVT_SPIN(id, func)}
Generated whenever an arrow is pressed.
@event{EVT_SPIN_UP(id, func)}
Generated when left/up arrow is pressed.
@event{EVT_SPIN_DOWN(id, func)}
Generated when right/down arrow is pressed.
@endEventTable
Note that if you handle both SPIN and UP or DOWN events, you will be notified
about each of them twice: first the UP/DOWN event will be received and then,
if it wasn't vetoed, the SPIN event will be sent.
@library{wxcore}
@category{events}
@@ -41,16 +53,17 @@ public:
/**
@class wxSpinButton
A wxSpinButton has two small up and down (or left and right) arrow buttons. It
is often used next to a text control for increment and decrementing a value.
Portable programs should try to use wxSpinCtrl instead
as wxSpinButton is not implemented for all platforms but wxSpinCtrl is as it
degenerates to a simple wxTextCtrl on such platforms.
A wxSpinButton has two small up and down (or left and right) arrow buttons.
It is often used next to a text control for increment and decrementing a value.
Portable programs should try to use wxSpinCtrl instead as wxSpinButton is not
implemented for all platforms but wxSpinCtrl is as it degenerates to a simple
wxTextCtrl on such platforms.
@note the range supported by this control (and wxSpinCtrl) depends on the
platform but is at least @c -0x8000 to @c 0x7fff. Under GTK and
Win32 with sufficiently new version of @c comctrl32.dll (at least 4.71 is
required, 5.80 is recommended) the full 32 bit range is supported.
platform but is at least @c -0x8000 to @c 0x7fff. Under GTK and
Win32 with sufficiently new version of @c comctrl32.dll (at least 4.71
is required, 5.80 is recommended) the full 32 bit range is supported.
@beginStyleTable
@style{wxSP_HORIZONTAL}
@@ -64,6 +77,19 @@ public:
The value wraps at the minimum and maximum.
@endStyleTable
@beginEventTable{wxSpinEvent}
@event{EVT_SPIN(id, func)}
Generated whenever an arrow is pressed.
@event{EVT_SPIN_UP(id, func)}
Generated when left/up arrow is pressed.
@event{EVT_SPIN_DOWN(id, func)}
Generated when right/down arrow is pressed.
@endEventTable
Note that if you handle both SPIN and UP or DOWN events, you will be notified
about each of them twice: first the UP/DOWN event will be received and then,
if it wasn't vetoed, the SPIN event will be sent.
@library{wxcore}
@category{ctrl}
<!-- @appearance{spinbutton.png} -->
@@ -77,7 +103,7 @@ public:
Default constructor.
*/
wxSpinButton();
/**
Constructor, creating and showing a spin button.
@@ -86,13 +112,13 @@ public:
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param pos
Window position. If wxDefaultPosition is specified then a default
position is chosen.
Window position.
If wxDefaultPosition is specified then a default position is chosen.
@param size
Window size. If wxDefaultSize is specified then a default size
is chosen.
Window size.
If wxDefaultSize is specified then a default size is chosen.
@param style
Window style. See wxSpinButton.
Window style. See wxSpinButton class description.
@param name
Window name.
interface/wx/spinctrl.h
+24 -10
View File
@@ -9,8 +9,7 @@
/**
@class wxSpinCtrl
wxSpinCtrl combines wxTextCtrl and
wxSpinButton in one control.
wxSpinCtrl combines wxTextCtrl and wxSpinButton in one control.
@beginStyleTable
@style{wxSP_ARROW_KEYS}
@@ -24,6 +23,20 @@
dialog) under MSW.
@endStyleTable
@beginEventTable{wxSpinEvent}
@event{EVT_SPINCTRL(id, func)}
Generated whenever the numeric value of the spinctrl is updated
@endEventTable
You may also use the wxSpinButton event macros, however the corresponding events
will not be generated under all platforms. Finally, if the user modifies the
text in the edit part of the spin control directly, the EVT_TEXT is generated,
like for the wxTextCtrl. When the use enters text into the text area, the text
is not validated until the control loses focus (e.g. by using the TAB key).
The value is then adjusted to the range and a wxSpinEvent sent then if the value
is different from the last value sent.
@library{wxcore}
@category{ctrl}
<!-- @appearance{spinctrl.png} -->
@@ -37,7 +50,7 @@ public:
Default constructor.
*/
wxSpinCtrl();
/**
Constructor, creating and showing a spin control.
@@ -48,11 +61,11 @@ public:
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param pos
Window position. If wxDefaultPosition is specified then a default
position is chosen.
Window position.
If wxDefaultPosition is specified then a default position is chosen.
@param size
Window size. If wxDefaultSize is specified then a default size
is chosen.
Window size.
If wxDefaultSize is specified then a default size is chosen.
@param style
Window style. See wxSpinButton.
@param min
@@ -108,10 +121,11 @@ public:
/**
Select the text in the text part of the control between positions
@a from (inclusive) and @a to (exclusive). This is similar to
wxTextCtrl::SetSelection.
@a from (inclusive) and @a to (exclusive).
This is similar to wxTextCtrl::SetSelection().
@note this is currently only implemented for Windows and generic versions
of the control.
of the control.
*/
void SetSelection(long from, long to);
interface/wx/splash.h
+13 -13
View File
@@ -10,15 +10,15 @@
@class wxSplashScreen
wxSplashScreen shows a window with a thin border, displaying a bitmap
describing your
application. Show it in application initialisation, and then either explicitly
destroy
describing your application.
Show it in application initialisation, and then either explicitly destroy
it or let it time-out.
Example usage:
@code
wxBitmap bitmap;
wxBitmap bitmap;
if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
{
wxSplashScreen* splash = new wxSplashScreen(bitmap,
@@ -37,14 +37,15 @@ class wxSplashScreen : public wxFrame
public:
/**
Construct the splash screen passing a bitmap, a style, a timeout, a window id,
optional position
and size, and a window style.
optional position and size, and a window style.
@a splashStyle is a bitlist of some of the following:
wxSPLASH_CENTRE_ON_PARENT
wxSPLASH_CENTRE_ON_SCREEN
wxSPLASH_NO_CENTRE
wxSPLASH_TIMEOUT
wxSPLASH_NO_TIMEOUT
- wxSPLASH_CENTRE_ON_PARENT
- wxSPLASH_CENTRE_ON_SCREEN
- wxSPLASH_NO_CENTRE
- wxSPLASH_TIMEOUT
- wxSPLASH_NO_TIMEOUT
@a milliseconds is the timeout in milliseconds.
*/
wxSplashScreen(const wxBitmap& bitmap, long splashStyle,
@@ -61,8 +62,7 @@ public:
virtual ~wxSplashScreen();
/**
Returns the splash style (see wxSplashScreen() for
details).
Returns the splash style (see wxSplashScreen() for details).
*/
long GetSplashStyle() const;
interface/wx/splitter.h
+125 -77
View File
@@ -9,10 +9,8 @@
/**
@class wxSplitterWindow
@ref overview_wxsplitterwindowoverview "wxSplitterWindow overview"
This class manages up to two subwindows. The current view can be
split into two programmatically (perhaps from a menu command), and unsplit
This class manages up to two subwindows. The current view can be split
into two programmatically (perhaps from a menu command), and unsplit
either programmatically or via the wxSplitterWindow user interface.
@beginStyleTable
@@ -33,16 +31,35 @@
using Windows XP theming, so the borders and sash will take on the
pre-XP look.
@style{wxSP_PERMIT_UNSPLIT}
Always allow to unsplit, even with the minimum pane size other than
zero.
Always allow to unsplit, even with the minimum pane size other than zero.
@style{wxSP_LIVE_UPDATE}
Don't draw XOR line but resize the child windows immediately.
@endStyleTable
@beginEventTable{wxSplitterEvent}
@event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)}
The sash position is in the process of being changed.
May be used to modify the position of the tracking bar to properly
reflect the position that would be set if the drag were to be completed
at this point. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
@event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
The sash position was changed. May be used to modify the sash position
before it is set, or to prevent the change from taking place.
Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
@event{EVT_SPLITTER_UNSPLIT(id, func)}
The splitter has been just unsplit. Processes a wxEVT_COMMAND_SPLITTER_UNSPLIT event.
@event{EVT_SPLITTER_DCLICK(id, func)}
The sash was double clicked. The default behaviour is to unsplit the
window when this happens (unless the minimum pane size has been set
to a value greater than zero). Processes a wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
@endEventTable
@library{wxcore}
@category{miscwnd}
@see wxSplitterEvent
@see wxSplitterEvent, @ref overview_splitterwindow
*/
class wxSplitterWindow : public wxWindow
{
@@ -51,7 +68,7 @@ public:
Default constructor
*/
wxSplitterWindow();
/**
Constructor for creating the window.
@@ -68,18 +85,18 @@ public:
@param name
The window name.
@remarks After using this constructor, you must create either one or two
subwindows with the splitter window as parent, and then
call one of Initialize(),
SplitVertically() and
SplitHorizontally() in order to set the
pane(s).
@remarks
After using this constructor, you must create either one or two
subwindows with the splitter window as parent, and then call one
of Initialize(), SplitVertically() and SplitHorizontally() in order
to set the pane(s).
You can create two windows, with one hidden when not being shown;
or you can create and delete the second pane on demand.
@see Initialize(), SplitVertically(),
SplitHorizontally(), Create()
@see Initialize(), SplitVertically(), SplitHorizontally(), Create()
*/
wxSplitterWindow(wxWindow* parent, wxWindowID id,
const wxPoint& point = wxDefaultPosition,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxSP_3D,
const wxString& name = "splitterWindow");
@@ -90,8 +107,8 @@ public:
virtual ~wxSplitterWindow();
/**
Creation function, for two-step construction. See wxSplitterWindow() for
details.
Creation function, for two-step construction.
See wxSplitterWindow() for details.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxPoint& point = wxDefaultPosition,
@@ -123,8 +140,7 @@ public:
/**
Gets the split mode.
@see SetSplitMode(), SplitVertically(),
SplitHorizontally().
@see SetSplitMode(), SplitVertically(), SplitHorizontally().
*/
int GetSplitMode() const;
@@ -139,8 +155,8 @@ public:
wxWindow* GetWindow2() const;
/**
Initializes the splitter window to have one pane. The child window is
shown if it is currently hidden.
Initializes the splitter window to have one pane.
The child window is shown if it is currently hidden.
@param window
The pane for the unsplit window.
@@ -204,6 +220,7 @@ public:
and then resplitting the window back because it will provoke much less flicker
(if any). It is valid to call this function whether the splitter has two
windows or only one.
Both parameters should be non-@NULL and @a winOld must specify one of the
windows managed by the splitter. If the parameters are incorrect or the window
couldn't be replaced, @false is returned. Otherwise the function will return
@@ -238,6 +255,19 @@ public:
@param gravity
The sash gravity. Value between 0.0 and 1.0.
@remarks
Gravity is real factor which controls position of sash while resizing
wxSplitterWindow. Gravity tells wxSplitterWindow how much will left/top
window grow while resizing.
Example values:
- 0.0: only the bottom/right window is automatically resized
- 0.5: both windows grow by equal size
- 1.0: only left/top window grows
Gravity should be a real value between 0.0 and 1.0.
Default value of sash gravity is 0.0.
That value is compatible with previous (before gravity was introduced)
behaviour of wxSplitterWindow.
@see GetSashGravity()
*/
void SetSashGravity(double gravity);
@@ -273,65 +303,59 @@ public:
@remarks Only sets the internal variable; does not update the display.
@see GetSplitMode(), SplitVertically(),
SplitHorizontally().
@see GetSplitMode(), SplitVertically(), SplitHorizontally().
*/
void SetSplitMode(int mode);
/**
Initializes the top and bottom panes of the splitter window. The
child windows are shown if they are currently hidden.
Initializes the top and bottom panes of the splitter window.
The child windows are shown if they are currently hidden.
@param window1
The top pane.
@param window2
The bottom pane.
@param sashPosition
The initial position of the sash. If this value is
positive, it specifies the size of the upper pane. If it is negative, its
absolute value gives the size of the lower pane. Finally, specify 0
(default)
to choose the default position (half of the total window height).
The initial position of the sash. If this value is positive,
it specifies the size of the upper pane. If it is negative, its
absolute value gives the size of the lower pane.
Finally, specify 0 (default) to choose the default position
(half of the total window height).
@return @true if successful, @false otherwise (the window was already
split).
@return @true if successful, @false otherwise (the window was already split).
@remarks This should be called if you wish to initially view two panes.
It can also be called at any subsequent time, but the
application should check that the window is not
currently split using IsSplit.
It can also be called at any subsequent time, but the application
should check that the window is not currently split using IsSplit().
@see SplitVertically(), IsSplit(),
Unsplit()
@see SplitVertically(), IsSplit(), Unsplit()
*/
bool SplitHorizontally(wxWindow* window1, wxWindow* window2,
int sashPosition = 0);
/**
Initializes the left and right panes of the splitter window. The
child windows are shown if they are currently hidden.
Initializes the left and right panes of the splitter window.
The child windows are shown if they are currently hidden.
@param window1
The left pane.
@param window2
The right pane.
@param sashPosition
The initial position of the sash. If this value is
positive, it specifies the size of the left pane. If it is negative, it is
absolute value gives the size of the right pane. Finally, specify 0
(default)
to choose the default position (half of the total window width).
The initial position of the sash. If this value is positive, it
specifies the size of the left pane. If it is negative, it is
absolute value gives the size of the right pane.
Finally, specify 0 (default) to choose the default position
(half of the total window width).
@return @true if successful, @false otherwise (the window was already
split).
@return @true if successful, @false otherwise (the window was already split).
@remarks This should be called if you wish to initially view two panes.
It can also be called at any subsequent time, but the
application should check that the window is not
currently split using IsSplit.
application should check that the window is not currently
split using IsSplit().
@see SplitHorizontally(), IsSplit(),
Unsplit().
@see SplitHorizontally(), IsSplit(), Unsplit().
*/
bool SplitVertically(wxWindow* window1, wxWindow* window2,
int sashPosition = 0);
@@ -345,23 +369,23 @@ public:
@return @true if successful, @false otherwise (the window was not split).
@remarks This call will not actually delete the pane being removed; it
calls OnUnsplit which can be overridden for the desired
calls OnUnsplit() which can be overridden for the desired
behaviour. By default, the pane being removed is hidden.
@see SplitHorizontally(), SplitVertically(),
IsSplit(), OnUnsplit()
@see SplitHorizontally(), SplitVertically(), IsSplit(), OnUnsplit()
*/
bool Unsplit(wxWindow* toRemove = NULL);
/**
Causes any pending sizing of the sash and child panes to take place
immediately.
Such resizing normally takes place in idle time, in order
to wait for layout to be completed. However, this can cause
unacceptable flicker as the panes are resized after the window has been
shown. To work around this, you can perform window layout (for
example by sending a size event to the parent window), and then
call this function, before showing the top-level window.
Such resizing normally takes place in idle time, in order to wait for
layout to be completed. However, this can cause unacceptable flicker as
the panes are resized after the window has been shown.
To work around this, you can perform window layout (for example by
sending a size event to the parent window), and then call this function,
before showing the top-level window.
*/
void UpdateSize();
};
@@ -371,17 +395,36 @@ public:
/**
@class wxSplitterEvent
This class represents the events generated by a splitter control. Also there is
only one event class, the data associated to the different events is not the
same and so not all accessor functions may be called for each event. The
documentation mentions the kind of event(s) for which the given accessor
This class represents the events generated by a splitter control.
Also there is only one event class, the data associated to the different events
is not the same and so not all accessor functions may be called for each event.
The documentation mentions the kind of event(s) for which the given accessor
function makes sense: calling it for other types of events will result
in assert failure (in debug mode) and will return meaningless results.
@beginEventTable{wxSplitterEvent}
@event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)}
The sash position is in the process of being changed.
May be used to modify the position of the tracking bar to properly
reflect the position that would be set if the drag were to be completed
at this point. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
@event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
The sash position was changed. May be used to modify the sash position
before it is set, or to prevent the change from taking place.
Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
@event{EVT_SPLITTER_UNSPLIT(id, func)}
The splitter has been just unsplit. Processes a wxEVT_COMMAND_SPLITTER_UNSPLIT event.
@event{EVT_SPLITTER_DCLICK(id, func)}
The sash was double clicked. The default behaviour is to unsplit the
window when this happens (unless the minimum pane size has been set
to a value greater than zero). Processes a wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
@endEventTable
@library{wxcore}
@category{events}
@see wxSplitterWindow, @ref overview_eventhandlingoverview
@see wxSplitterWindow, @ref overview_eventhandling
*/
class wxSplitterEvent : public wxNotifyEvent
{
@@ -394,44 +437,49 @@ public:
/**
Returns the new sash position.
May only be called while processing
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
@c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
@c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
*/
int GetSashPosition() const;
/**
Returns a pointer to the window being removed when a splitter window
is unsplit.
May only be called while processing
wxEVT_COMMAND_SPLITTER_UNSPLIT events.
@c wxEVT_COMMAND_SPLITTER_UNSPLIT events.
*/
wxWindow* GetWindowBeingRemoved() const;
/**
Returns the x coordinate of the double-click point.
May only be called while processing
wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.
@c wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.
*/
int GetX() const;
/**
Returns the y coordinate of the double-click point.
May only be called while processing
wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.
@c wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.
*/
int GetY() const;
/**
In the case of wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events,
sets the new sash position. In the case of
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING events, sets the new
tracking bar position so visual feedback during dragging will
In the case of @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events,
sets the new sash position.
In the case of @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING events,
sets the new tracking bar position so visual feedback during dragging will
represent that change that will actually take place. Set to -1 from
the event handler code to prevent repositioning.
May only be called while processing
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
@c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
@c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
@param pos
New sash position.
interface/wx/srchctrl.h
+19 -9
View File
@@ -39,8 +39,19 @@
capitalized.
@endStyleTable
@beginEventTable{wxCommandEvent}
To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events,
just as you would with wxTextCtrl.
@event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)}
Respond to a wxEVT_SEARCHCTRL_SEARCH_BTN event, generated when the
search button is clicked. Note that this does not initiate a search.
@event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)}
Respond to a wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
cancel button is clicked.
@endEventTable
@library{wxcore}
@category{FIXME}
@category{ctrl}
@see wxTextCtrl::Create, wxValidator
*/
@@ -51,7 +62,7 @@ public:
Default constructor
*/
wxSearchCtrl();
/**
Constructor, creating and showing a text control.
@@ -96,16 +107,15 @@ public:
/**
Returns the search button visibility value.
If there is a menu attached, the search button will be visible regardless of
the search
button visibility value.
the search button visibility value.
This always returns @false in Mac OS X v10.3
*/
virtual bool IsSearchButtonVisible() const;
/**
Sets the search control's menu object. If there is already a menu associated
with
the search control it is deleted.
Sets the search control's menu object.
If there is already a menu associated with the search control it is deleted.
@param menu
Menu to attach to the search control.
@@ -120,8 +130,8 @@ public:
/**
Sets the search button visibility value on the search control.
If there is a menu attached, the search button will be visible regardless of
the search
button visibility value.
the search button visibility value.
This has no effect in Mac OS X v10.3
*/
virtual void ShowSearchButton(bool show);
interface/wx/sstream.h
+14 -11
View File
@@ -9,8 +9,8 @@
/**
@class wxStringInputStream
This class implements an input stream which reads data from a string. It
supports seeking.
This class implements an input stream which reads data from a string.
It supports seeking.
@library{wxbase}
@category{streams}
@@ -19,9 +19,11 @@ class wxStringInputStream : public wxInputStream
{
public:
/**
Creates a new read-only stream using the specified string. Note that the string
is copied by the stream so if the original string is modified after using this
constructor, changes to it are not reflected when reading from stream.
Creates a new read-only stream using the specified string.
Note that the string is copied by the stream so if the original string is
modified after using this constructor, changes to it are not reflected
when reading from stream.
*/
wxStringInputStream(const wxString& s);
};
@@ -32,8 +34,10 @@ public:
@class wxStringOutputStream
This class implements an output stream which writes data either to a
user-provided or internally allocated string. Note that currently this stream
does not support seeking but can tell its current position.
user-provided or internally allocated string.
Note that currently this stream does not support seeking but can tell
its current position.
@library{wxbase}
@category{streams}
@@ -50,15 +54,14 @@ public:
If @a str is used, data written to the stream is appended to the current
contents of it, i.e. the string is not cleared here. However if it is not
empty, the positions returned by wxOutputStream::TellO will be
offset by the initial string length, i.e. initial stream position will be the
empty, the positions returned by wxOutputStream::TellO will be offset by
the initial string length, i.e. initial stream position will be the
initial length of the string and not 0.
Notice that the life time of @a conv must be greater than the life time
of this object itself as it stores a reference to it. Also notice that
with default value of this argument the data written to the stream must
be valid UTF-8, pass @c wxConvISO8859_1 to deal with arbitrary 8 bit
data.
be valid UTF-8, pass @c wxConvISO8859_1 to deal with arbitrary 8 bit data.
*/
wxStringOutputStream(wxString str = NULL, wxMBConv& conv = wxConvUTF8);