interface revisions
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56417 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
969daeea66
commit
89bb3f0244
@ -9,10 +9,9 @@
|
||||
/**
|
||||
@class wxImageList
|
||||
|
||||
A wxImageList contains a list of images, which are stored in
|
||||
an unspecified form. Images can have masks for transparent
|
||||
drawing, and can be made from a variety of sources including bitmaps
|
||||
and icons.
|
||||
A wxImageList contains a list of images, which are stored in an unspecified
|
||||
form. Images can have masks for transparent drawing, and can be made from a
|
||||
variety of sources including bitmaps and icons.
|
||||
|
||||
wxImageList is used principally in conjunction with wxTreeCtrl and
|
||||
wxListCtrl classes.
|
||||
@ -25,7 +24,11 @@
|
||||
class wxImageList : public wxObject
|
||||
{
|
||||
public:
|
||||
//@{
|
||||
/**
|
||||
Default ctor.
|
||||
*/
|
||||
wxImageList();
|
||||
|
||||
/**
|
||||
Constructor specifying the image size, whether image masks should be created,
|
||||
and the initial size of the list.
|
||||
@ -41,34 +44,64 @@ public:
|
||||
|
||||
@see Create()
|
||||
*/
|
||||
wxImageList();
|
||||
wxImageList(int width, int height, bool mask = true,
|
||||
int initialCount = 1);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
/**
|
||||
Adds a new image using an icon.
|
||||
Adds a new image or images using a bitmap and optional mask bitmap.
|
||||
|
||||
@param bitmap
|
||||
Bitmap representing the opaque areas of the image.
|
||||
@param mask
|
||||
Monochrome mask bitmap, representing the transparent areas of the image.
|
||||
|
||||
@return The new zero-based image index.
|
||||
|
||||
@remarks The original bitmap or icon is not affected by the Add()
|
||||
operation, and can be deleted afterwards.
|
||||
If the bitmap is wider than the images in the list, then the
|
||||
bitmap will automatically be split into smaller images, each
|
||||
matching the dimensions of the image list.
|
||||
This does not apply when adding icons.
|
||||
*/
|
||||
int Add(const wxBitmap& bitmap,
|
||||
const wxBitmap& mask = wxNullBitmap);
|
||||
|
||||
/**
|
||||
Adds a new image or images using a bitmap and mask colour.
|
||||
|
||||
@param bitmap
|
||||
Bitmap representing the opaque areas of the image.
|
||||
@param maskColour
|
||||
Colour indicating which parts of the image are transparent.
|
||||
|
||||
@return The new zero-based image index.
|
||||
|
||||
@remarks The original bitmap or icon is not affected by the Add()
|
||||
operation, and can be deleted afterwards.
|
||||
If the bitmap is wider than the images in the list, then the
|
||||
bitmap will automatically be split into smaller images, each
|
||||
matching the dimensions of the image list.
|
||||
This does not apply when adding icons.
|
||||
*/
|
||||
int Add(const wxBitmap& bitmap, const wxColour& maskColour);
|
||||
|
||||
/**
|
||||
Adds a new image using an icon.
|
||||
|
||||
@param icon
|
||||
Icon to use as the image.
|
||||
|
||||
@return The new zero-based image index.
|
||||
|
||||
@remarks The original bitmap or icon is not affected by the Add
|
||||
@remarks The original bitmap or icon is not affected by the Add()
|
||||
operation, and can be deleted afterwards.
|
||||
If the bitmap is wider than the images in the list, then the
|
||||
bitmap will automatically be split into smaller images, each
|
||||
matching the dimensions of the image list.
|
||||
This does not apply when adding icons.
|
||||
*/
|
||||
int Add(const wxBitmap& bitmap,
|
||||
const wxBitmap& mask = wxNullBitmap);
|
||||
int Add(const wxBitmap& bitmap, const wxColour& maskColour);
|
||||
int Add(const wxIcon& icon);
|
||||
//@}
|
||||
|
||||
/**
|
||||
Initializes the list. See wxImageList() for details.
|
||||
@ -89,51 +122,10 @@ public:
|
||||
Y position on the device context.
|
||||
@param flags
|
||||
How to draw the image. A bitlist of a selection of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
wxIMAGELIST_DRAW_NORMAL
|
||||
|
||||
|
||||
|
||||
|
||||
Draw the image normally.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
wxIMAGELIST_DRAW_TRANSPARENT
|
||||
|
||||
|
||||
|
||||
|
||||
Draw the image with transparency.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
wxIMAGELIST_DRAW_SELECTED
|
||||
|
||||
|
||||
|
||||
|
||||
Draw the image in selected state.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
wxIMAGELIST_DRAW_FOCUSED
|
||||
|
||||
|
||||
|
||||
|
||||
Draw the image in a focused state.
|
||||
- wxIMAGELIST_DRAW_NORMAL: Draw the image normally.
|
||||
- wxIMAGELIST_DRAW_TRANSPARENT: Draw the image with transparency.
|
||||
- wxIMAGELIST_DRAW_SELECTED: Draw the image in selected state.
|
||||
- wxIMAGELIST_DRAW_FOCUSED: Draw the image in a focused state.
|
||||
@param solidBackground
|
||||
For optimisation - drawing can be faster if the function is told
|
||||
that the background is solid.
|
||||
@ -168,8 +160,8 @@ public:
|
||||
@param height
|
||||
receives the height of the images in the list
|
||||
|
||||
@return @true if the function succeeded, @false if it failed (for example,
|
||||
if the image list was not yet initialized).
|
||||
@return @true if the function succeeded, @false if it failed
|
||||
(for example, if the image list was not yet initialized).
|
||||
*/
|
||||
virtual bool GetSize(int index, int& width, int& height) const;
|
||||
|
||||
@ -183,25 +175,38 @@ public:
|
||||
*/
|
||||
bool RemoveAll();
|
||||
|
||||
//@{
|
||||
/**
|
||||
Replaces the existing image with the new image.
|
||||
Windows only.
|
||||
|
||||
@param index
|
||||
The index of the bitmap to be replaced.
|
||||
@param bitmap
|
||||
Bitmap representing the opaque areas of the image.
|
||||
@param mask
|
||||
Monochrome mask bitmap, representing the transparent areas of the image.
|
||||
|
||||
@return @true if the replacement was successful, @false otherwise.
|
||||
|
||||
@remarks The original bitmap or icon is not affected by the Replace()
|
||||
operation, and can be deleted afterwards.
|
||||
*/
|
||||
bool Replace(int index, const wxBitmap& bitmap,
|
||||
const wxBitmap& mask = wxNullBitmap);
|
||||
|
||||
/**
|
||||
Replaces the existing image with the new image.
|
||||
|
||||
@param index
|
||||
The index of the bitmap to be replaced.
|
||||
@param icon
|
||||
Icon to use as the image.
|
||||
|
||||
@return @true if the replacement was successful, @false otherwise.
|
||||
|
||||
@remarks The original bitmap or icon is not affected by the Replace
|
||||
@remarks The original bitmap or icon is not affected by the Replace()
|
||||
operation, and can be deleted afterwards.
|
||||
*/
|
||||
bool Replace(int index, const wxBitmap& bitmap,
|
||||
const wxBitmap& mask = wxNullBitmap);
|
||||
bool Replace(int index, const wxIcon& icon);
|
||||
//@}
|
||||
};
|
||||
|
||||
|
@ -341,7 +341,7 @@ struct WXDLLIMPEXP_BASE wxLanguageInfo
|
||||
@library{wxbase}
|
||||
@category{misc}
|
||||
|
||||
@see @ref overview_internationalization, @ref page_samples_internat, wxXLocale
|
||||
@see @ref overview_i18n, @ref page_samples_internat, wxXLocale
|
||||
*/
|
||||
class wxLocale
|
||||
{
|
||||
@ -611,6 +611,16 @@ public:
|
||||
iso8859-2 and windows-1250. See @ref overview_nonenglish for
|
||||
detailed description of this behaviour.
|
||||
Note that this flag is meaningless in Unicode build.
|
||||
|
||||
@return @true on success or @false if the given locale couldn't be set.
|
||||
*/
|
||||
bool Init(int language = wxLANGUAGE_DEFAULT,
|
||||
int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
|
||||
|
||||
/**
|
||||
@deprecated
|
||||
This form is deprecated, use the other one unless you know what you are doing.
|
||||
|
||||
@param name
|
||||
The name of the locale. Only used in diagnostic messages.
|
||||
@param short
|
||||
@ -629,15 +639,6 @@ public:
|
||||
between well-known pair like iso8859-1 and windows-1252 or iso8859-2
|
||||
and windows-1250.
|
||||
See @ref overview_nonenglish for detailed description of this behaviour.
|
||||
|
||||
@return @true on success or @false if the given locale couldn't be set.
|
||||
*/
|
||||
bool Init(int language = wxLANGUAGE_DEFAULT,
|
||||
int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
|
||||
|
||||
/**
|
||||
@deprecated
|
||||
This form is deprecated, use the other one unless you know what you are doing.
|
||||
*/
|
||||
bool Init(const wxString& name,
|
||||
const wxString& short = wxEmptyString,
|
||||
|
@ -9,47 +9,47 @@
|
||||
/**
|
||||
@class wxConnection
|
||||
|
||||
A wxConnection object represents the connection between a client
|
||||
and a server. It is created by making a connection using a
|
||||
wxClient object, or by the acceptance of a
|
||||
connection by a wxServer object. The
|
||||
bulk of a DDE-like (Dynamic Data Exchange) conversation is
|
||||
controlled by calling members in a @b wxConnection object or
|
||||
by overriding its members. The actual DDE-based implementation
|
||||
using wxDDEConnection is available on Windows only, but a
|
||||
platform-independent, socket-based version of this API is
|
||||
A wxConnection object represents the connection between a client and a server.
|
||||
It is created by making a connection using a wxClient object, or by the acceptance
|
||||
of a connection by a wxServer object.
|
||||
|
||||
The bulk of a DDE-like (Dynamic Data Exchange) conversation is controlled by
|
||||
calling members in a @b wxConnection object or by overriding its members.
|
||||
The actual DDE-based implementation using wxDDEConnection is available on
|
||||
Windows only, but a platform-independent, socket-based version of this API is
|
||||
available using wxTCPConnection, which has the same API.
|
||||
|
||||
An application should normally derive a new connection class from
|
||||
wxConnection, in order to override the communication event
|
||||
handlers to do something interesting.
|
||||
An application should normally derive a new connection class from wxConnection,
|
||||
in order to override the communication event handlers to do something interesting.
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
@category{ipc}
|
||||
|
||||
@see wxClient, wxServer, @ref overview_ipcoverview "Interprocess communications
|
||||
overview"
|
||||
@see wxClient, wxServer, @ref overview_ipc
|
||||
*/
|
||||
class wxConnection : public wxObject
|
||||
{
|
||||
public:
|
||||
//@{
|
||||
/**
|
||||
Constructs a connection object. If no user-defined connection
|
||||
object is to be derived from wxConnection, then the constructor
|
||||
should not be called directly, since the default connection
|
||||
object will be provided on requesting (or accepting) a
|
||||
connection. However, if the user defines his or her own derived
|
||||
connection object, the wxServer::OnAcceptConnection
|
||||
and/or wxClient::OnMakeConnection
|
||||
Constructs a connection object.
|
||||
|
||||
If no user-defined connection object is to be derived from wxConnection,
|
||||
then the constructor should not be called directly, since the default connection
|
||||
object will be provided on requesting (or accepting) a connection.
|
||||
|
||||
However, if the user defines his or her own derived connection object,
|
||||
the wxServer::OnAcceptConnection and/or wxClient::OnMakeConnection
|
||||
members should be replaced by functions which construct the new
|
||||
connection object.
|
||||
|
||||
If the arguments of the wxConnection constructor are void then
|
||||
the wxConnection object manages its own connection buffer,
|
||||
allocating memory as needed. A programmer-supplied buffer cannot
|
||||
be increased if necessary, and the program will assert if it is
|
||||
not large enough. The programmer-supplied buffer is included
|
||||
mainly for backwards compatibility.
|
||||
not large enough.
|
||||
|
||||
The programmer-supplied buffer is included mainly for backwards compatibility.
|
||||
*/
|
||||
wxConnection();
|
||||
wxConnection(void* buffer, size_t size);
|
||||
@ -59,8 +59,9 @@ public:
|
||||
/**
|
||||
Called by the server application to advise the client of a change
|
||||
in the data associated with the given item. Causes the client
|
||||
connection's OnAdvise() member
|
||||
to be called. Returns @true if successful.
|
||||
connection's OnAdvise() member to be called.
|
||||
|
||||
@return @true if successful.
|
||||
*/
|
||||
bool Advise(const wxString& item, const void* data, size_t size,
|
||||
wxIPCFormat format = wxIPC_PRIVATE);
|
||||
@ -71,20 +72,20 @@ public:
|
||||
|
||||
/**
|
||||
Called by the client or server application to disconnect from the
|
||||
other program; it causes the OnDisconnect()
|
||||
message to be sent to the corresponding connection object in the
|
||||
other program. Returns @true if successful or already disconnected.
|
||||
The application that calls @b Disconnect must explicitly delete
|
||||
other program; it causes the OnDisconnect() message to be sent to the
|
||||
corresponding connection object in the other program.
|
||||
|
||||
Returns @true if successful or already disconnected.
|
||||
The application that calls Disconnect() must explicitly delete
|
||||
its side of the connection.
|
||||
*/
|
||||
bool Disconnect();
|
||||
|
||||
//@{
|
||||
/**
|
||||
Called by the client application to execute a command on the
|
||||
server. Can also be used to transfer arbitrary data to the server
|
||||
(similar to Poke() in
|
||||
that respect). Causes the server connection's OnExec()
|
||||
Called by the client application to execute a command on the server.
|
||||
Can also be used to transfer arbitrary data to the server (similar to
|
||||
Poke() in that respect). Causes the server connection's OnExec()
|
||||
member to be called. Returns @true if successful.
|
||||
*/
|
||||
bool Execute(const void* data, size_t size,
|
||||
@ -95,9 +96,8 @@ public:
|
||||
//@}
|
||||
|
||||
/**
|
||||
Message sent to the client application when the server notifies
|
||||
it of a change in the data associated with the given item, using
|
||||
Advise().
|
||||
Message sent to the client application when the server notifies it of a
|
||||
change in the data associated with the given item, using Advise().
|
||||
*/
|
||||
virtual bool OnAdvise(const wxString& topic,
|
||||
const wxString& item,
|
||||
@ -107,17 +107,19 @@ public:
|
||||
|
||||
/**
|
||||
Message sent to the client or server application when the other
|
||||
application notifies it to end the connection. The default
|
||||
behaviour is to delete the connection object and return @true, so
|
||||
applications should generally override @b OnDisconnect
|
||||
(finally calling the inherited method as well) so that they know
|
||||
the connection object is no longer available.
|
||||
application notifies it to end the connection.
|
||||
|
||||
The default behaviour is to delete the connection object and return @true,
|
||||
so applications should generally override OnDisconnect() (finally calling
|
||||
the inherited method as well) so that they know the connection object is
|
||||
no longer available.
|
||||
*/
|
||||
virtual bool OnDisconnect();
|
||||
|
||||
/**
|
||||
Message sent to the server application when the client notifies
|
||||
it to execute the given data, using Execute().
|
||||
|
||||
Note that there is no item associated with this message.
|
||||
*/
|
||||
virtual bool OnExec(const wxString& topic, const wxString& data);
|
||||
@ -132,12 +134,11 @@ public:
|
||||
wxIPCFormat format);
|
||||
|
||||
/**
|
||||
Message sent to the server application when the client calls
|
||||
Request(). The
|
||||
server's OnRequest() method
|
||||
should respond by returning a character string, or @NULL to
|
||||
indicate no data, and setting *size. The character string must of
|
||||
course persist after the call returns.
|
||||
Message sent to the server application when the client calls Request().
|
||||
The server's OnRequest() method should respond by returning a character
|
||||
string, or @NULL to indicate no data, and setting *size.
|
||||
|
||||
The character string must of course persist after the call returns.
|
||||
*/
|
||||
virtual const void* OnRequest(const wxString& topic,
|
||||
const wxString& item,
|
||||
@ -146,16 +147,16 @@ public:
|
||||
|
||||
/**
|
||||
Message sent to the server application by the client, when the client
|
||||
wishes to start an 'advise loop' for the given topic and item. The
|
||||
server can refuse to participate by returning @false.
|
||||
wishes to start an 'advise loop' for the given topic and item.
|
||||
The server can refuse to participate by returning @false.
|
||||
*/
|
||||
virtual bool OnStartAdvise(const wxString& topic,
|
||||
const wxString& item);
|
||||
|
||||
/**
|
||||
Message sent to the server application by the client, when the client
|
||||
wishes to stop an 'advise loop' for the given topic and item. The
|
||||
server can refuse to stop the advise loop by returning @false, although
|
||||
wishes to stop an 'advise loop' for the given topic and item.
|
||||
The server can refuse to stop the advise loop by returning @false, although
|
||||
this doesn't have much meaning in practice.
|
||||
*/
|
||||
virtual bool OnStopAdvise(const wxString& topic,
|
||||
@ -164,10 +165,10 @@ public:
|
||||
//@{
|
||||
/**
|
||||
Called by the client application to poke data into the server.
|
||||
Can be used to transfer arbitrary data to the server. Causes the
|
||||
server connection's OnPoke() member to
|
||||
be called. If size is -1 the size is computed from the string
|
||||
length of data.
|
||||
Can be used to transfer arbitrary data to the server.
|
||||
Causes the server connection's OnPoke() member to be called.
|
||||
If size is -1 the size is computed from the string length of data.
|
||||
|
||||
Returns @true if successful.
|
||||
*/
|
||||
bool Poke(const wxString& item, const void* data, size_t size,
|
||||
@ -179,34 +180,31 @@ public:
|
||||
|
||||
/**
|
||||
Called by the client application to request data from the server.
|
||||
Causes the server connection's OnRequest()
|
||||
member to be called. Size may be @NULL or a pointer to a variable
|
||||
to receive the size of the requested item.
|
||||
Returns a character string (actually a pointer to the
|
||||
connection's buffer) if successful, @NULL otherwise. This buffer
|
||||
does not need to be deleted.
|
||||
Causes the server connection's OnRequest() member to be called.
|
||||
Size may be @NULL or a pointer to a variable to receive the size of the
|
||||
requested item.
|
||||
|
||||
Returns a character string (actually a pointer to the connection's buffer)
|
||||
if successful, @NULL otherwise. This buffer does not need to be deleted.
|
||||
*/
|
||||
const void* Request(const wxString& item, size_t* size,
|
||||
wxIPCFormat format = wxIPC_TEXT);
|
||||
|
||||
/**
|
||||
Called by the client application to ask if an advise loop can be
|
||||
started with the server. Causes the server connection's
|
||||
OnStartAdvise()
|
||||
member to be called. Returns @true if the server okays it, @false
|
||||
otherwise.
|
||||
Called by the client application to ask if an advise loop can be started
|
||||
with the server. Causes the server connection's OnStartAdvise()
|
||||
member to be called.
|
||||
Returns @true if the server okays it, @false otherwise.
|
||||
*/
|
||||
bool StartAdvise(const wxString& item);
|
||||
|
||||
/**
|
||||
Called by the client application to ask if an advise loop can be
|
||||
stopped. Causes the server connection's OnStopAdvise()
|
||||
member to be called. Returns @true if the server okays it, @false
|
||||
otherwise.
|
||||
Called by the client application to ask if an advise loop can be stopped.
|
||||
Causes the server connection's OnStopAdvise() member to be called.
|
||||
Returns @true if the server okays it, @false otherwise.
|
||||
*/
|
||||
bool StopAdvise(const wxString& item);
|
||||
|
||||
|
||||
/**
|
||||
Returns true if the format is one of the text formats.
|
||||
|
||||
@ -239,27 +237,24 @@ public:
|
||||
@class wxClient
|
||||
|
||||
A wxClient object represents the client part of a client-server
|
||||
DDE-like (Dynamic Data Exchange) conversation. The actual
|
||||
DDE-based implementation using wxDDEClient is available on Windows
|
||||
only, but a platform-independent, socket-based version of this
|
||||
API is available using wxTCPClient, which has the same API.
|
||||
DDE-like (Dynamic Data Exchange) conversation.
|
||||
The actual DDE-based implementation using wxDDEClient is available on Windows
|
||||
only, but a platform-independent, socket-based version of this API is available
|
||||
using wxTCPClient, which has the same API.
|
||||
|
||||
To create a client which can communicate with a suitable server,
|
||||
you need to derive a class from wxConnection and another from
|
||||
wxClient. The custom wxConnection class will intercept
|
||||
communications in a 'conversation' with a server, and the custom
|
||||
wxClient is required so that a user-overridden
|
||||
wxClient::OnMakeConnection
|
||||
member can return a wxConnection of the required class, when a
|
||||
connection is made. Look at the IPC sample and the
|
||||
@ref overview_ipcoverview "Interprocess communications overview" for
|
||||
an example of how to do this.
|
||||
To create a client which can communicate with a suitable server, you need to
|
||||
derive a class from wxConnection and another from wxClient.
|
||||
The custom wxConnection class will intercept communications in a 'conversation'
|
||||
with a server, and the custom wxClient is required so that a user-overridden
|
||||
wxClient::OnMakeConnection member can return a wxConnection of the required
|
||||
class, when a connection is made.
|
||||
|
||||
Look at the IPC sample and the @ref overview_ipc for an example of how to do this.
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
@category{ipc}
|
||||
|
||||
@see wxServer, wxConnection, @ref overview_ipcoverview "Interprocess
|
||||
communications overview"
|
||||
@see wxServer, wxConnection, @ref overview_ipc
|
||||
*/
|
||||
class wxClient : public wxObject
|
||||
{
|
||||
@ -272,41 +267,41 @@ public:
|
||||
/**
|
||||
Tries to make a connection with a server by host (machine name
|
||||
under UNIX - use 'localhost' for same machine; ignored when using
|
||||
native DDE in Windows), service name and topic string. If the
|
||||
server allows a connection, a wxConnection object will be
|
||||
returned. The type of wxConnection returned can be altered by
|
||||
overriding the
|
||||
OnMakeConnection()
|
||||
member to return your own derived connection object.
|
||||
native DDE in Windows), service name and topic string.
|
||||
|
||||
If the server allows a connection, a wxConnection object will be returned.
|
||||
The type of wxConnection returned can be altered by overriding the
|
||||
OnMakeConnection() member to return your own derived connection object.
|
||||
|
||||
Under Unix, the service name may be either an integer port
|
||||
identifier in which case an Internet domain socket will be used
|
||||
for the communications, or a valid file name (which shouldn't
|
||||
exist and will be deleted afterwards) in which case a Unix domain
|
||||
socket is created.
|
||||
@b SECURITY NOTE: Using Internet domain sockets if extremely
|
||||
insecure for IPC as there is absolutely no access control for
|
||||
them, use Unix domain sockets whenever possible!
|
||||
|
||||
@note Using Internet domain sockets if extremely insecure for IPC as
|
||||
there is absolutely no access control for them, use Unix domain
|
||||
sockets whenever possible!
|
||||
*/
|
||||
wxConnectionBase* MakeConnection(const wxString& host,
|
||||
const wxString& service,
|
||||
const wxString& topic);
|
||||
|
||||
/**
|
||||
Called by MakeConnection(), by
|
||||
default this simply returns a new wxConnection object. Override
|
||||
this method to return a wxConnection descendant customised for the
|
||||
application.
|
||||
The advantage of deriving your own connection class is that it
|
||||
will enable you to intercept messages initiated by the server,
|
||||
such as wxConnection::OnAdvise. You
|
||||
may also want to store application-specific data in instances of
|
||||
Called by MakeConnection(), by default this simply returns a new wxConnection
|
||||
object. Override this method to return a wxConnection descendant customised
|
||||
for the application.
|
||||
|
||||
The advantage of deriving your own connection class is that it will enable
|
||||
you to intercept messages initiated by the server, such as wxConnection::OnAdvise.
|
||||
You may also want to store application-specific data in instances of
|
||||
the new class.
|
||||
*/
|
||||
wxConnectionBase* OnMakeConnection();
|
||||
|
||||
/**
|
||||
Returns @true if this is a valid host name, @false otherwise. This always
|
||||
returns @true under MS Windows.
|
||||
Returns @true if this is a valid host name, @false otherwise.
|
||||
This always returns @true under MS Windows.
|
||||
*/
|
||||
bool ValidHost(const wxString& host);
|
||||
};
|
||||
@ -316,26 +311,24 @@ public:
|
||||
/**
|
||||
@class wxServer
|
||||
|
||||
A wxServer object represents the server part of a client-server
|
||||
DDE-like (Dynamic Data Exchange) conversation. The actual
|
||||
DDE-based implementation using wxDDEServer is available on Windows
|
||||
only, but a platform-independent, socket-based version of this
|
||||
API is available using wxTCPServer, which has the same API.
|
||||
A wxServer object represents the server part of a client-server DDE-like
|
||||
(Dynamic Data Exchange) conversation. The actual DDE-based implementation
|
||||
using wxDDEServer is available on Windows only, but a platform-independent,
|
||||
socket-based version of this API is available using wxTCPServer, which has
|
||||
the same API.
|
||||
|
||||
To create a server which can communicate with a suitable client,
|
||||
you need to derive a class from wxConnection and another from
|
||||
wxServer. The custom wxConnection class will intercept
|
||||
communications in a 'conversation' with a client, and the custom
|
||||
wxServer is required so that a user-overridden wxServer::OnAcceptConnection
|
||||
member can return a wxConnection of the required class, when a
|
||||
connection is made. Look at the IPC sample and the @ref overview_ipcoverview
|
||||
"Interprocess communications overview" for
|
||||
an example of how to do this.
|
||||
To create a server which can communicate with a suitable client, you need to
|
||||
derive a class from wxConnection and another from wxServer.
|
||||
The custom wxConnection class will intercept communications in a 'conversation'
|
||||
with a client, and the custom wxServer is required so that a user-overridden
|
||||
wxServer::OnAcceptConnection member can return a wxConnection of the required
|
||||
class, when a connection is made.
|
||||
Look at the IPC sample and the @ref overview_ipc for an example of how to do this.
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
@category{ipc}
|
||||
|
||||
@see wxClient, wxConnection, IPC, overview()
|
||||
@see wxClient, wxConnection, IPC, @ref overview_ipc
|
||||
*/
|
||||
class wxServer
|
||||
{
|
||||
@ -346,13 +339,14 @@ public:
|
||||
wxServer();
|
||||
|
||||
/**
|
||||
Registers the server using the given service name. Under Unix,
|
||||
the service name may be either an integer port identifier in
|
||||
which case an Internet domain socket will be used for the
|
||||
communications, or a valid file name (which shouldn't exist and
|
||||
will be deleted afterwards) in which case a Unix domain socket is
|
||||
created. @false is returned if the call failed (for example, the
|
||||
port number is already in use).
|
||||
Registers the server using the given service name.
|
||||
Under Unix, the service name may be either an integer port identifier in
|
||||
which case an Internet domain socket will be used for the communications,
|
||||
or a valid file name (which shouldn't exist and will be deleted afterwards)
|
||||
in which case a Unix domain socket is created.
|
||||
|
||||
@false is returned if the call failed (for example, the port number is
|
||||
already in use).
|
||||
*/
|
||||
bool Create(const wxString& service);
|
||||
|
||||
@ -362,11 +356,11 @@ public:
|
||||
member to intercept this message and return a connection object of
|
||||
either the standard wxConnection type, or (more likely) of a
|
||||
user-derived type.
|
||||
|
||||
If the topic is @b STDIO, the application may wish to refuse the
|
||||
connection. Under UNIX, when a server is created the
|
||||
OnAcceptConnection message is always sent for standard input and
|
||||
output, but in the context of DDE messages it doesn't make a lot
|
||||
of sense.
|
||||
connection. Under UNIX, when a server is created the OnAcceptConnection()
|
||||
message is always sent for standard input and output, but in the context
|
||||
of DDE messages it doesn't make a lot of sense.
|
||||
*/
|
||||
virtual wxConnectionBase* OnAcceptConnection(const wxString& topic);
|
||||
};
|
||||
|
@ -6,6 +6,9 @@
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
An enumeration for formats .
|
||||
*/
|
||||
enum wxIPCFormat
|
||||
{
|
||||
wxIPC_INVALID = 0,
|
||||
|
@ -12,7 +12,7 @@
|
||||
wxJoystick allows an application to control one or more joysticks.
|
||||
|
||||
@library{wxadv}
|
||||
@category{FIXME}
|
||||
@category{misc}
|
||||
|
||||
@see wxJoystickEvent
|
||||
*/
|
||||
@ -20,8 +20,9 @@ class wxJoystick : public wxObject
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Constructor. @a joystick may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the
|
||||
joystick
|
||||
Constructor.
|
||||
|
||||
@a joystick may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the joystick
|
||||
controller of interest.
|
||||
*/
|
||||
wxJoystick(int joystick = wxJOYSTICK1);
|
||||
@ -31,16 +32,23 @@ public:
|
||||
*/
|
||||
virtual ~wxJoystick();
|
||||
|
||||
//@{
|
||||
/**
|
||||
Returns the state of the joystick buttons.
|
||||
Every button is mapped to a single bit in the returned integer, with the
|
||||
first button being mapped to the least significant bit, and so on.
|
||||
|
||||
A bitlist of wxJOY_BUTTONn identifiers, where n is 1, 2, 3 or 4 is available
|
||||
for historical reasons.
|
||||
*/
|
||||
int GetButtonState() const;
|
||||
|
||||
/**
|
||||
Returns the state of the specified joystick button.
|
||||
|
||||
@param id
|
||||
The button id to report, from 0 to GetNumberButtons() - 1
|
||||
*/
|
||||
int GetButtonState() const;
|
||||
const bool GetButtonState(unsigned id) const;
|
||||
//@}
|
||||
bool GetButtonState(unsigned id) const;
|
||||
|
||||
/**
|
||||
Returns the manufacturer id.
|
||||
@ -72,14 +80,15 @@ public:
|
||||
/**
|
||||
Returns the point-of-view position, expressed in continuous, one-hundredth of a
|
||||
degree units.
|
||||
|
||||
Returns -1 on error.
|
||||
*/
|
||||
int GetPOVCTSPosition() const;
|
||||
|
||||
/**
|
||||
Returns the point-of-view position, expressed in continuous, one-hundredth of a
|
||||
degree units,
|
||||
but limited to return 0, 9000, 18000 or 27000.
|
||||
degree units, but limited to return 0, 9000, 18000 or 27000.
|
||||
|
||||
Returns -1 on error.
|
||||
*/
|
||||
int GetPOVPosition() const;
|
||||
@ -94,16 +103,18 @@ public:
|
||||
*/
|
||||
int GetPollingMin() const;
|
||||
|
||||
//@{
|
||||
/**
|
||||
Returns the x, y position of the joystick.
|
||||
*/
|
||||
wxPoint GetPosition() const;
|
||||
|
||||
/**
|
||||
Returns the position of the specified joystick axis.
|
||||
|
||||
@param axis
|
||||
The joystick axis to report, from 0 to GetNumberAxes() - 1.
|
||||
*/
|
||||
wxPoint GetPosition() const;
|
||||
const int GetPosition(unsigned axis) const;
|
||||
//@}
|
||||
int GetPosition(unsigned axis) const;
|
||||
|
||||
/**
|
||||
Returns the product id for the joystick.
|
||||
@ -201,15 +212,15 @@ public:
|
||||
bool HasPOV() const;
|
||||
|
||||
/**
|
||||
Returns @true if the joystick point-of-view supports discrete values (centered,
|
||||
forward, backward, left, and right).
|
||||
Returns @true if the joystick point-of-view supports discrete values
|
||||
(centered, forward, backward, left, and right).
|
||||
*/
|
||||
bool HasPOV4Dir() const;
|
||||
|
||||
/**
|
||||
Returns @true if the joystick point-of-view supports continuous degree bearings.
|
||||
*/
|
||||
#define bool HasPOVCTS() const /* implementation is private */
|
||||
bool HasPOVCTS() const;
|
||||
|
||||
/**
|
||||
Returns @true if there is a rudder attached to the computer.
|
||||
@ -246,14 +257,13 @@ public:
|
||||
bool ReleaseCapture();
|
||||
|
||||
/**
|
||||
Sets the capture to direct joystick events to @e win.
|
||||
Sets the capture to direct joystick events to @a win.
|
||||
|
||||
@param win
|
||||
The window that will receive joystick events.
|
||||
@param pollingFreq
|
||||
If zero, movement events are sent when above the
|
||||
threshold. If greater than zero, events are received every pollingFreq
|
||||
milliseconds.
|
||||
If zero, movement events are sent when above the threshold.
|
||||
If greater than zero, events are received every @a pollingFreq milliseconds.
|
||||
|
||||
@return @true if the capture succeeded.
|
||||
|
||||
@ -263,8 +273,7 @@ public:
|
||||
|
||||
/**
|
||||
Sets the movement threshold, the number of steps outside which the joystick is
|
||||
deemed to have
|
||||
moved.
|
||||
deemed to have moved.
|
||||
*/
|
||||
void SetMovementThreshold(int threshold);
|
||||
};
|
||||
|
Loading…
Reference in New Issue
Block a user