other s*h interface revisions

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

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.