Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

interface revisions

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56417 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-17 20:55:12 +00:00
parent 969daeea66
commit 89bb3f0244
5 changed files with 245 additions and 233 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
interface/wx/imaglist.h
View File

@@ -9,10 +9,9 @@
/** /**
@class wxImageList @class wxImageList
A wxImageList contains a list of images, which are stored in A wxImageList contains a list of images, which are stored in an unspecified
an unspecified form. Images can have masks for transparent form. Images can have masks for transparent drawing, and can be made from a
drawing, and can be made from a variety of sources including bitmaps variety of sources including bitmaps and icons.
and icons.
wxImageList is used principally in conjunction with wxTreeCtrl and wxImageList is used principally in conjunction with wxTreeCtrl and
wxListCtrl classes. wxListCtrl classes.
@@ -25,7 +24,11 @@
class wxImageList : public wxObject class wxImageList : public wxObject
{ {
public: public:
//@{ /**
Default ctor.
*/
wxImageList();
/** /**
Constructor specifying the image size, whether image masks should be created, Constructor specifying the image size, whether image masks should be created,
and the initial size of the list. and the initial size of the list.
@@ -41,34 +44,64 @@ public:
@see Create() @see Create()
*/ */
wxImageList();
wxImageList(int width, int height, bool mask = true, wxImageList(int width, int height, bool mask = true,
int initialCount = 1); 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 @param bitmap
Bitmap representing the opaque areas of the image. Bitmap representing the opaque areas of the image.
@param mask @param mask
Monochrome mask bitmap, representing the transparent areas of the image. 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 @param maskColour
Colour indicating which parts of the image are transparent. 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 @param icon
Icon to use as the image. Icon to use as the image.
@return The new zero-based image index. @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. 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); int Add(const wxIcon& icon);
//@}
/** /**
Initializes the list. See wxImageList() for details. Initializes the list. See wxImageList() for details.
@@ -89,51 +122,10 @@ public:
Y position on the device context. Y position on the device context.
@param flags @param flags
How to draw the image. A bitlist of a selection of the following: 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 @param solidBackground
For optimisation - drawing can be faster if the function is told For optimisation - drawing can be faster if the function is told
that the background is solid. that the background is solid.
@@ -168,8 +160,8 @@ public:
@param height @param height
receives the height of the images in the list receives the height of the images in the list
@return @true if the function succeeded, @false if it failed (for example, @return @true if the function succeeded, @false if it failed
if the image list was not yet initialized). (for example, if the image list was not yet initialized).
*/ */
virtual bool GetSize(int index, int& width, int& height) const; virtual bool GetSize(int index, int& width, int& height) const;
@@ -183,25 +175,38 @@ public:
*/ */
bool RemoveAll(); bool RemoveAll();
//@{
/** /**
Replaces the existing image with the new image. Replaces the existing image with the new image.
Windows only.
@param index
The index of the bitmap to be replaced.
@param bitmap @param bitmap
Bitmap representing the opaque areas of the image. Bitmap representing the opaque areas of the image.
@param mask @param mask
Monochrome mask bitmap, representing the transparent areas of the image. 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 @param icon
Icon to use as the image. Icon to use as the image.
@return @true if the replacement was successful, @false otherwise. @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. operation, and can be deleted afterwards.
*/ */
bool Replace(int index, const wxBitmap& bitmap,
const wxBitmap& mask = wxNullBitmap);
bool Replace(int index, const wxIcon& icon); bool Replace(int index, const wxIcon& icon);
//@}
}; };

21
interface/wx/intl.h
View File

@@ -341,7 +341,7 @@ struct WXDLLIMPEXP_BASE wxLanguageInfo
@library{wxbase} @library{wxbase}
@category{misc} @category{misc}
@see @ref overview_internationalization, @ref page_samples_internat, wxXLocale @see @ref overview_i18n, @ref page_samples_internat, wxXLocale
*/ */
class wxLocale class wxLocale
{ {
@@ -611,6 +611,16 @@ public:
iso8859-2 and windows-1250. See @ref overview_nonenglish for iso8859-2 and windows-1250. See @ref overview_nonenglish for
detailed description of this behaviour. detailed description of this behaviour.
Note that this flag is meaningless in Unicode build. 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 @param name
The name of the locale. Only used in diagnostic messages. The name of the locale. Only used in diagnostic messages.
@param short @param short
@@ -629,15 +639,6 @@ public:
between well-known pair like iso8859-1 and windows-1252 or iso8859-2 between well-known pair like iso8859-1 and windows-1252 or iso8859-2
and windows-1250. and windows-1250.
See @ref overview_nonenglish for detailed description of this behaviour. 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, bool Init(const wxString& name,
const wxString& short = wxEmptyString, const wxString& short = wxEmptyString,

264
interface/wx/ipc.h
View File

@@ -9,47 +9,47 @@
/** /**
@class wxConnection @class wxConnection
A wxConnection object represents the connection between a client A wxConnection object represents the connection between a client and a server.
and a server. It is created by making a connection using a It is created by making a connection using a wxClient object, or by the acceptance
wxClient object, or by the acceptance of a of a connection by a wxServer object.
connection by a wxServer object. The
bulk of a DDE-like (Dynamic Data Exchange) conversation is The bulk of a DDE-like (Dynamic Data Exchange) conversation is controlled by
controlled by calling members in a @b wxConnection object or calling members in a @b wxConnection object or by overriding its members.
by overriding its members. The actual DDE-based implementation The actual DDE-based implementation using wxDDEConnection is available on
using wxDDEConnection is available on Windows only, but a Windows only, but a platform-independent, socket-based version of this API is
platform-independent, socket-based version of this API is
available using wxTCPConnection, which has the same API. available using wxTCPConnection, which has the same API.
An application should normally derive a new connection class from An application should normally derive a new connection class from wxConnection,
wxConnection, in order to override the communication event in order to override the communication event handlers to do something interesting.
handlers to do something interesting.
@library{wxbase} @library{wxbase}
@category{FIXME} @category{ipc}
@see wxClient, wxServer, @ref overview_ipcoverview "Interprocess communications @see wxClient, wxServer, @ref overview_ipc
overview"
*/ */
class wxConnection : public wxObject class wxConnection : public wxObject
{ {
public: public:
//@{ //@{
/** /**
Constructs a connection object. If no user-defined connection Constructs a connection object.
object is to be derived from wxConnection, then the constructor
should not be called directly, since the default connection If no user-defined connection object is to be derived from wxConnection,
object will be provided on requesting (or accepting) a then the constructor should not be called directly, since the default connection
connection. However, if the user defines his or her own derived object will be provided on requesting (or accepting) a connection.
connection object, the wxServer::OnAcceptConnection
and/or wxClient::OnMakeConnection 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 members should be replaced by functions which construct the new
connection object. connection object.
If the arguments of the wxConnection constructor are void then If the arguments of the wxConnection constructor are void then
the wxConnection object manages its own connection buffer, the wxConnection object manages its own connection buffer,
allocating memory as needed. A programmer-supplied buffer cannot allocating memory as needed. A programmer-supplied buffer cannot
be increased if necessary, and the program will assert if it is be increased if necessary, and the program will assert if it is
not large enough. The programmer-supplied buffer is included not large enough.
mainly for backwards compatibility.
The programmer-supplied buffer is included mainly for backwards compatibility.
*/ */
wxConnection(); wxConnection();
wxConnection(void* buffer, size_t size); wxConnection(void* buffer, size_t size);
@@ -59,8 +59,9 @@ public:
/** /**
Called by the server application to advise the client of a change Called by the server application to advise the client of a change
in the data associated with the given item. Causes the client in the data associated with the given item. Causes the client
connection's OnAdvise() member connection's OnAdvise() member to be called.
to be called. Returns @true if successful.
@return @true if successful.
*/ */
bool Advise(const wxString& item, const void* data, size_t size, bool Advise(const wxString& item, const void* data, size_t size,
wxIPCFormat format = wxIPC_PRIVATE); wxIPCFormat format = wxIPC_PRIVATE);
@@ -71,20 +72,20 @@ public:
/** /**
Called by the client or server application to disconnect from the Called by the client or server application to disconnect from the
other program; it causes the OnDisconnect() other program; it causes the OnDisconnect() message to be sent to the
message to be sent to the corresponding connection object in the corresponding connection object in the other program.
other program. Returns @true if successful or already disconnected.
The application that calls @b Disconnect must explicitly delete Returns @true if successful or already disconnected.
The application that calls Disconnect() must explicitly delete
its side of the connection. its side of the connection.
*/ */
bool Disconnect(); bool Disconnect();
//@{ //@{
/** /**
Called by the client application to execute a command on the Called by the client application to execute a command on the server.
server. Can also be used to transfer arbitrary data to the server Can also be used to transfer arbitrary data to the server (similar to
(similar to Poke() in Poke() in that respect). Causes the server connection's OnExec()
that respect). Causes the server connection's OnExec()
member to be called. Returns @true if successful. member to be called. Returns @true if successful.
*/ */
bool Execute(const void* data, size_t size, bool Execute(const void* data, size_t size,
@@ -95,9 +96,8 @@ public:
//@} //@}
/** /**
Message sent to the client application when the server notifies Message sent to the client application when the server notifies it of a
it of a change in the data associated with the given item, using change in the data associated with the given item, using Advise().
Advise().
*/ */
virtual bool OnAdvise(const wxString& topic, virtual bool OnAdvise(const wxString& topic,
const wxString& item, const wxString& item,
@@ -107,17 +107,19 @@ public:
/** /**
Message sent to the client or server application when the other Message sent to the client or server application when the other
application notifies it to end the connection. The default application notifies it to end the connection.
behaviour is to delete the connection object and return @true, so
applications should generally override @b OnDisconnect The default behaviour is to delete the connection object and return @true,
(finally calling the inherited method as well) so that they know so applications should generally override OnDisconnect() (finally calling
the connection object is no longer available. the inherited method as well) so that they know the connection object is
no longer available.
*/ */
virtual bool OnDisconnect(); virtual bool OnDisconnect();
/** /**
Message sent to the server application when the client notifies Message sent to the server application when the client notifies
it to execute the given data, using Execute(). it to execute the given data, using Execute().
Note that there is no item associated with this message. Note that there is no item associated with this message.
*/ */
virtual bool OnExec(const wxString& topic, const wxString& data); virtual bool OnExec(const wxString& topic, const wxString& data);
@@ -132,12 +134,11 @@ public:
wxIPCFormat format); wxIPCFormat format);
/** /**
Message sent to the server application when the client calls Message sent to the server application when the client calls Request().
Request(). The The server's OnRequest() method should respond by returning a character
server's OnRequest() method string, or @NULL to indicate no data, and setting *size.
should respond by returning a character string, or @NULL to
indicate no data, and setting *size. The character string must of The character string must of course persist after the call returns.
course persist after the call returns.
*/ */
virtual const void* OnRequest(const wxString& topic, virtual const void* OnRequest(const wxString& topic,
const wxString& item, const wxString& item,
@@ -146,16 +147,16 @@ public:
/** /**
Message sent to the server application by the client, when the client 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 wishes to start an 'advise loop' for the given topic and item.
server can refuse to participate by returning @false. The server can refuse to participate by returning @false.
*/ */
virtual bool OnStartAdvise(const wxString& topic, virtual bool OnStartAdvise(const wxString& topic,
const wxString& item); const wxString& item);
/** /**
Message sent to the server application by the client, when the client 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 wishes to stop an 'advise loop' for the given topic and item.
server can refuse to stop the advise loop by returning @false, although The server can refuse to stop the advise loop by returning @false, although
this doesn't have much meaning in practice. this doesn't have much meaning in practice.
*/ */
virtual bool OnStopAdvise(const wxString& topic, virtual bool OnStopAdvise(const wxString& topic,
@@ -164,10 +165,10 @@ public:
//@{ //@{
/** /**
Called by the client application to poke data into the server. Called by the client application to poke data into the server.
Can be used to transfer arbitrary data to the server. Causes the Can be used to transfer arbitrary data to the server.
server connection's OnPoke() member to Causes the server connection's OnPoke() member to be called.
be called. If size is -1 the size is computed from the string If size is -1 the size is computed from the string length of data.
length of data.
Returns @true if successful. Returns @true if successful.
*/ */
bool Poke(const wxString& item, const void* data, size_t size, 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. Called by the client application to request data from the server.
Causes the server connection's OnRequest() Causes the server connection's OnRequest() member to be called.
member to be called. Size may be @NULL or a pointer to a variable Size may be @NULL or a pointer to a variable to receive the size of the
to receive the size of the requested item. requested item.
Returns a character string (actually a pointer to the
connection's buffer) if successful, @NULL otherwise. This buffer Returns a character string (actually a pointer to the connection's buffer)
does not need to be deleted. if successful, @NULL otherwise. This buffer does not need to be deleted.
*/ */
const void* Request(const wxString& item, size_t* size, const void* Request(const wxString& item, size_t* size,
wxIPCFormat format = wxIPC_TEXT); wxIPCFormat format = wxIPC_TEXT);
/** /**
Called by the client application to ask if an advise loop can be Called by the client application to ask if an advise loop can be started
started with the server. Causes the server connection's with the server. Causes the server connection's OnStartAdvise()
OnStartAdvise() member to be called.
member to be called. Returns @true if the server okays it, @false Returns @true if the server okays it, @false otherwise.
otherwise.
*/ */
bool StartAdvise(const wxString& item); bool StartAdvise(const wxString& item);
/** /**
Called by the client application to ask if an advise loop can be Called by the client application to ask if an advise loop can be stopped.
stopped. Causes the server connection's OnStopAdvise() Causes the server connection's OnStopAdvise() member to be called.
member to be called. Returns @true if the server okays it, @false Returns @true if the server okays it, @false otherwise.
otherwise.
*/ */
bool StopAdvise(const wxString& item); bool StopAdvise(const wxString& item);
/** /**
Returns true if the format is one of the text formats. Returns true if the format is one of the text formats.
@@ -239,27 +237,24 @@ public:
@class wxClient @class wxClient
A wxClient object represents the client part of a client-server A wxClient object represents the client part of a client-server
DDE-like (Dynamic Data Exchange) conversation. The actual DDE-like (Dynamic Data Exchange) conversation.
DDE-based implementation using wxDDEClient is available on Windows The actual DDE-based implementation using wxDDEClient is available on Windows
only, but a platform-independent, socket-based version of this only, but a platform-independent, socket-based version of this API is available
API is available using wxTCPClient, which has the same API. using wxTCPClient, which has the same API.
To create a client which can communicate with a suitable server, To create a client which can communicate with a suitable server, you need to
you need to derive a class from wxConnection and another from derive a class from wxConnection and another from wxClient.
wxClient. The custom wxConnection class will intercept The custom wxConnection class will intercept communications in a 'conversation'
communications in a 'conversation' with a server, and the custom with a server, and the custom wxClient is required so that a user-overridden
wxClient is required so that a user-overridden wxClient::OnMakeConnection member can return a wxConnection of the required
wxClient::OnMakeConnection class, when a connection is made.
member can return a wxConnection of the required class, when a
connection is made. Look at the IPC sample and the Look at the IPC sample and the @ref overview_ipc for an example of how to do this.
@ref overview_ipcoverview "Interprocess communications overview" for
an example of how to do this.
@library{wxbase} @library{wxbase}
@category{FIXME} @category{ipc}
@see wxServer, wxConnection, @ref overview_ipcoverview "Interprocess @see wxServer, wxConnection, @ref overview_ipc
communications overview"
*/ */
class wxClient : public wxObject class wxClient : public wxObject
{ {
@@ -272,41 +267,41 @@ public:
/** /**
Tries to make a connection with a server by host (machine name Tries to make a connection with a server by host (machine name
under UNIX - use 'localhost' for same machine; ignored when using under UNIX - use 'localhost' for same machine; ignored when using
native DDE in Windows), service name and topic string. If the native DDE in Windows), service name and topic string.
server allows a connection, a wxConnection object will be
returned. The type of wxConnection returned can be altered by If the server allows a connection, a wxConnection object will be returned.
overriding the The type of wxConnection returned can be altered by overriding the
OnMakeConnection() OnMakeConnection() member to return your own derived connection object.
member to return your own derived connection object.
Under Unix, the service name may be either an integer port Under Unix, the service name may be either an integer port
identifier in which case an Internet domain socket will be used identifier in which case an Internet domain socket will be used
for the communications, or a valid file name (which shouldn't for the communications, or a valid file name (which shouldn't
exist and will be deleted afterwards) in which case a Unix domain exist and will be deleted afterwards) in which case a Unix domain
socket is created. socket is created.
@b SECURITY NOTE: Using Internet domain sockets if extremely
insecure for IPC as there is absolutely no access control for @note Using Internet domain sockets if extremely insecure for IPC as
them, use Unix domain sockets whenever possible! there is absolutely no access control for them, use Unix domain
sockets whenever possible!
*/ */
wxConnectionBase* MakeConnection(const wxString& host, wxConnectionBase* MakeConnection(const wxString& host,
const wxString& service, const wxString& service,
const wxString& topic); const wxString& topic);
/** /**
Called by MakeConnection(), by Called by MakeConnection(), by default this simply returns a new wxConnection
default this simply returns a new wxConnection object. Override object. Override this method to return a wxConnection descendant customised
this method to return a wxConnection descendant customised for the for the application.
application.
The advantage of deriving your own connection class is that it The advantage of deriving your own connection class is that it will enable
will enable you to intercept messages initiated by the server, you to intercept messages initiated by the server, such as wxConnection::OnAdvise.
such as wxConnection::OnAdvise. You You may also want to store application-specific data in instances of
may also want to store application-specific data in instances of
the new class. the new class.
*/ */
wxConnectionBase* OnMakeConnection(); wxConnectionBase* OnMakeConnection();
/** /**
Returns @true if this is a valid host name, @false otherwise. This always Returns @true if this is a valid host name, @false otherwise.
returns @true under MS Windows. This always returns @true under MS Windows.
*/ */
bool ValidHost(const wxString& host); bool ValidHost(const wxString& host);
}; };
@@ -316,26 +311,24 @@ public:
/** /**
@class wxServer @class wxServer
A wxServer object represents the server part of a client-server A wxServer object represents the server part of a client-server DDE-like
DDE-like (Dynamic Data Exchange) conversation. The actual (Dynamic Data Exchange) conversation. The actual DDE-based implementation
DDE-based implementation using wxDDEServer is available on Windows using wxDDEServer is available on Windows only, but a platform-independent,
only, but a platform-independent, socket-based version of this socket-based version of this API is available using wxTCPServer, which has
API is available using wxTCPServer, which has the same API. the same API.
To create a server which can communicate with a suitable client, To create a server which can communicate with a suitable client, you need to
you need to derive a class from wxConnection and another from derive a class from wxConnection and another from wxServer.
wxServer. The custom wxConnection class will intercept The custom wxConnection class will intercept communications in a 'conversation'
communications in a 'conversation' with a client, and the custom with a client, and the custom wxServer is required so that a user-overridden
wxServer is required so that a user-overridden wxServer::OnAcceptConnection wxServer::OnAcceptConnection member can return a wxConnection of the required
member can return a wxConnection of the required class, when a class, when a connection is made.
connection is made. Look at the IPC sample and the @ref overview_ipcoverview Look at the IPC sample and the @ref overview_ipc for an example of how to do this.
"Interprocess communications overview" for
an example of how to do this.
@library{wxbase} @library{wxbase}
@category{FIXME} @category{ipc}
@see wxClient, wxConnection, IPC, overview() @see wxClient, wxConnection, IPC, @ref overview_ipc
*/ */
class wxServer class wxServer
{ {
@@ -346,13 +339,14 @@ public:
wxServer(); wxServer();
/** /**
Registers the server using the given service name. Under Unix, Registers the server using the given service name.
the service name may be either an integer port identifier in Under Unix, the service name may be either an integer port identifier in
which case an Internet domain socket will be used for the which case an Internet domain socket will be used for the communications,
communications, or a valid file name (which shouldn't exist and or a valid file name (which shouldn't exist and will be deleted afterwards)
will be deleted afterwards) in which case a Unix domain socket is in which case a Unix domain socket is created.
created. @false is returned if the call failed (for example, the
port number is already in use). @false is returned if the call failed (for example, the port number is
already in use).
*/ */
bool Create(const wxString& service); bool Create(const wxString& service);
@@ -362,11 +356,11 @@ public:
member to intercept this message and return a connection object of member to intercept this message and return a connection object of
either the standard wxConnection type, or (more likely) of a either the standard wxConnection type, or (more likely) of a
user-derived type. user-derived type.
If the topic is @b STDIO, the application may wish to refuse the If the topic is @b STDIO, the application may wish to refuse the
connection. Under UNIX, when a server is created the connection. Under UNIX, when a server is created the OnAcceptConnection()
OnAcceptConnection message is always sent for standard input and message is always sent for standard input and output, but in the context
output, but in the context of DDE messages it doesn't make a lot of DDE messages it doesn't make a lot of sense.
of sense.
*/ */
virtual wxConnectionBase* OnAcceptConnection(const wxString& topic); virtual wxConnectionBase* OnAcceptConnection(const wxString& topic);
}; };

3
interface/wx/ipcbase.h
View File

@@ -6,6 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/**
An enumeration for formats .
*/
enum wxIPCFormat enum wxIPCFormat
{ {
wxIPC_INVALID = 0, wxIPC_INVALID = 0,

53
interface/wx/joystick.h
View File

@@ -12,7 +12,7 @@
wxJoystick allows an application to control one or more joysticks. wxJoystick allows an application to control one or more joysticks.
@library{wxadv} @library{wxadv}
@category{FIXME} @category{misc}
@see wxJoystickEvent @see wxJoystickEvent
*/ */
@@ -20,8 +20,9 @@ class wxJoystick : public wxObject
{ {
public: public:
/** /**
Constructor. @a joystick may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the Constructor.
joystick
@a joystick may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the joystick
controller of interest. controller of interest.
*/ */
wxJoystick(int joystick = wxJOYSTICK1); wxJoystick(int joystick = wxJOYSTICK1);
@@ -31,16 +32,23 @@ public:
*/ */
virtual ~wxJoystick(); 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. Returns the state of the specified joystick button.
@param id @param id
The button id to report, from 0 to GetNumberButtons() - 1 The button id to report, from 0 to GetNumberButtons() - 1
*/ */
int GetButtonState() const; bool GetButtonState(unsigned id) const;
const bool GetButtonState(unsigned id) const;
//@}
/** /**
Returns the manufacturer id. Returns the manufacturer id.
@@ -72,14 +80,15 @@ public:
/** /**
Returns the point-of-view position, expressed in continuous, one-hundredth of a Returns the point-of-view position, expressed in continuous, one-hundredth of a
degree units. degree units.
Returns -1 on error. Returns -1 on error.
*/ */
int GetPOVCTSPosition() const; int GetPOVCTSPosition() const;
/** /**
Returns the point-of-view position, expressed in continuous, one-hundredth of a Returns the point-of-view position, expressed in continuous, one-hundredth of a
degree units, degree units, but limited to return 0, 9000, 18000 or 27000.
but limited to return 0, 9000, 18000 or 27000.
Returns -1 on error. Returns -1 on error.
*/ */
int GetPOVPosition() const; int GetPOVPosition() const;
@@ -94,16 +103,18 @@ public:
*/ */
int GetPollingMin() const; int GetPollingMin() const;
//@{ /**
Returns the x, y position of the joystick.
*/
wxPoint GetPosition() const;
/** /**
Returns the position of the specified joystick axis. Returns the position of the specified joystick axis.
@param axis @param axis
The joystick axis to report, from 0 to GetNumberAxes() - 1. The joystick axis to report, from 0 to GetNumberAxes() - 1.
*/ */
wxPoint GetPosition() const; int GetPosition(unsigned axis) const;
const int GetPosition(unsigned axis) const;
//@}
/** /**
Returns the product id for the joystick. Returns the product id for the joystick.
@@ -201,15 +212,15 @@ public:
bool HasPOV() const; bool HasPOV() const;
/** /**
Returns @true if the joystick point-of-view supports discrete values (centered, Returns @true if the joystick point-of-view supports discrete values
forward, backward, left, and right). (centered, forward, backward, left, and right).
*/ */
bool HasPOV4Dir() const; bool HasPOV4Dir() const;
/** /**
Returns @true if the joystick point-of-view supports continuous degree bearings. 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. Returns @true if there is a rudder attached to the computer.
@@ -246,14 +257,13 @@ public:
bool ReleaseCapture(); bool ReleaseCapture();
/** /**
Sets the capture to direct joystick events to @e win. Sets the capture to direct joystick events to @a win.
@param win @param win
The window that will receive joystick events. The window that will receive joystick events.
@param pollingFreq @param pollingFreq
If zero, movement events are sent when above the If zero, movement events are sent when above the threshold.
threshold. If greater than zero, events are received every pollingFreq If greater than zero, events are received every @a pollingFreq milliseconds.
milliseconds.
@return @true if the capture succeeded. @return @true if the capture succeeded.
@@ -263,8 +273,7 @@ public:
/** /**
Sets the movement threshold, the number of steps outside which the joystick is Sets the movement threshold, the number of steps outside which the joystick is
deemed to have deemed to have moved.
moved.
*/ */
void SetMovementThreshold(int threshold); void SetMovementThreshold(int threshold);
}; };