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@56440 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-19 12:49:07 +00:00
parent 3b644e9889
commit 320ab87c57
4 changed files with 483 additions and 490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
interface/wx/list.h
View File

@@ -80,7 +80,7 @@
@library{wxbase}
@category{FIXME}
@category{data}
@see wxArray<T>, wxVector<T>
*/

78
interface/wx/listbox.h
View File

@@ -9,25 +9,26 @@
/**
@class wxListBox
A listbox is used to select one or more of a list of strings. The
strings are displayed in a scrolling box, with the selected string(s)
marked in reverse video. A listbox can be single selection (if an item
is selected, the previous selection is removed) or multiple selection
A listbox is used to select one or more of a list of strings.
The strings are displayed in a scrolling box, with the selected string(s)
marked in reverse video. A listbox can be single selection (if an item is
selected, the previous selection is removed) or multiple selection
(clicking an item toggles the item on or off independently of other
selections).
List box elements are numbered from zero. Their number may be limited
under some platforms.
List box elements are numbered from zero.
Their number may be limited under some platforms.
A listbox callback gets an event wxEVT_COMMAND_LISTBOX_SELECTED for
single clicks, and wxEVT_COMMAND_LISTBOX_DOUBLECLICKED for double clicks.
A listbox callback gets an event @c wxEVT_COMMAND_LISTBOX_SELECTED for
single clicks, and @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED for double clicks.
@beginStyleTable
@style{wxLB_SINGLE}
Single-selection list.
@style{wxLB_MULTIPLE}
Multiple-selection list: the user can toggle multiple items on and
off. This is the same as wxLB_EXTENDED in wxGTK2 port.
Multiple-selection list: the user can toggle multiple items on and off.
This is the same as wxLB_EXTENDED in wxGTK2 port.
@style{wxLB_EXTENDED}
Extended-selection list: the user can extend the selection by using
@c SHIFT or @c CTRL keys together with the cursor movement keys or
@@ -42,13 +43,17 @@
The listbox contents are sorted in alphabetical order.
@endStyleTable
Note that @c wxLB_SINGLE, @c wxLB_MULTIPLE and @c wxLB_EXTENDED styles are
mutually exclusive and you can specify at most one of them (single selection
is the default). See also @ref overview_windowstyles.
@beginEventTable{wxCommandEvent}
@event{EVT_LISTBOX(id, func)}
Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
list is selected or the selection changes.
@event{EVT_LISTBOX_DCLICK(id, func)}
Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the
listbox is double-clicked.
Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the listbox
is double-clicked.
@endEventTable
@library{wxcore}
@@ -66,12 +71,27 @@ public:
wxListBox();
/**
Constructor
Constructor, creating and showing a list box.
@param parent
The parent window.
@param id
The ID of this control. A value of @c wxID_ANY indicates a default value.
@param pos
The initial position.
@param size
The initial size.
If wxDefaultSize is specified then the window is sized appropriately.
@param n
Number of strings with which to initialise the control.
@param choices
The strings to use to initialize the control.
@param style
Window style. See wxListBox.
@param validator
The validator for this control.
@param name
The name of this class.
*/
wxListBox(wxWindow* parent, wxWindowID id,
@@ -81,15 +101,14 @@ public:
const wxString choices[] = NULL,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "listBox");
const wxString& name = wxListBoxNameStr);
/**
Constructor
Constructor, creating and showing a list box.
@param choices
An array of strings with which to initialise the control.
@param style
Window style. See wxListBox.
See the other wxListBox() constructor; the only difference is that
this overload takes a wxArrayString instead of a pointer to an array
of wxString.
*/
wxListBox(wxWindow* parent, wxWindowID id,
@@ -98,7 +117,7 @@ public:
const wxArrayString& choices,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "listBox");
const wxString& name = wxListBoxNameStr);
/**
Destructor, destroying the list box.
@@ -107,8 +126,8 @@ public:
//@{
/**
Creates the listbox for two-step construction. See wxListBox()
for further details.
Creates the listbox for two-step construction.
See wxListBox() for further details.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
@@ -154,8 +173,8 @@ public:
virtual int GetSelections(wxArrayInt& selections) const;
/**
Returns the item located at @e point, or @c wxNOT_FOUND if there
is no item located at @e point.
Returns the item located at @a point, or @c wxNOT_FOUND if there
is no item located at @a point.
It is currently implemented for wxMSW, wxMac and wxGTK2 ports.
@@ -167,7 +186,7 @@ public:
@since 2.7.0
*/
int HitTest(const wxPoint point) const;
int HitTest(const wxPoint& point) const;
/**
Insert the given number of strings before the specified position.
@@ -189,7 +208,7 @@ public:
@param items
Labels of items to be inserted
@param pos
Position before which to insert the items: if pos is 0 the
Position before which to insert the items: if pos is @c 0 the
items will be inserted in the beginning of the listbox
*/
void InsertItems(const wxArrayString& items,
@@ -218,8 +237,8 @@ public:
void Set(int n, const wxString* choices, void **clientData = NULL);
/**
Clears the list box and adds the given strings to it. You may
free the array from the calling program after this method
Clears the list box and adds the given strings to it.
You may free the array from the calling program after this method
has been called.
@param choices
@@ -227,8 +246,7 @@ public:
@param clientData
Options array of client data pointers
*/
void Set(const wxArrayString& choices,
void **clientData = NULL);
void Set(const wxArrayString& choices, void **clientData = NULL);
/**
Set the specified item to be the first visible item.

749
interface/wx/listctrl.h
View File

File diff suppressed because it is too large Load Diff

86
interface/wx/xlocale.h
View File

@@ -11,6 +11,7 @@
@class wxXLocale
This class represents a locale object used by so-called xlocale API.
Unlike wxLocale it doesn't provide any non-trivial operations but simply
provides a portable wrapper for POSIX @c locale_t type.
@@ -52,12 +53,10 @@
@section xlocale_func Locale-dependent functions
Currently the following @c _l-functions are available:
Character classification functions: @c wxIsxxx_l(), e.g.
@c wxIsalpha_l(), @c wxIslower_l() and all the others.
Character transformation functions: @c wxTolower_l() and
@c wxToupper_l()
- Character classification functions:
@c wxIsxxx_l(), e.g. @c wxIsalpha_l(), @c wxIslower_l() and all the others.
- Character transformation functions:
@c wxTolower_l() and @c wxToupper_l()
We hope to provide many more functions (covering numbers, time and formatted
IO) in the near future.
@@ -69,75 +68,34 @@
class wxXLocale
{
public:
//@{
/**
Creates the locale object corresponding to the specified locale string. The
locale string is system-dependent, use constructor taking wxLanguage for better
portability.
Creates an uninitialized locale object, IsOk() method will return @false.
*/
wxLocale();
/**
Creates the locale object corresponding to the specified language.
*/
wxLocale(wxLanguage lang);
/**
Creates the locale object corresponding to the specified locale string.
The locale string is system-dependent, use constructor taking wxLanguage
for better portability.
*/
wxLocale(const char* loc);
//@}
/**
This class is fully implemented only under the platforms where xlocale POSIX
API or equivalent is available. Currently the xlocale API is available under
most of the recent Unix systems (including Linux, various BSD and Mac OS X) and
Microsoft Visual C++ standard library provides a similar API starting from
version 8 (Visual Studio 2005).
If neither POSIX API nor Microsoft proprietary equivalent are available, this
class is still available but works in degraded mode: the only supported locale
is the C one and attempts to create wxXLocale object for any other locale will
fail. You can use the preprocessor macro @c wxHAS_XLOCALE_SUPPORT to
test if full xlocale API is available or only skeleton C locale support is
present.
Notice that wxXLocale is new in wxWidgets 2.9.0 and is not compiled in if
@c wxUSE_XLOCALE was set to 0 during the library compilation.
Returns the global object representing the "C" locale.
For an even shorter access to this object a global @c wxCLocale variable
(implemented as a macro) is provided and can be used instead of calling
this method.
*/
/**
Returns the global object representing the "C" locale. For an even shorter
access to this object a global @c wxCLocale variable (implemented as a
macro) is provided and can be used instead of calling this method.
*/
static wxXLocale GetCLocale();
/**
This class represents a locale object used by so-called xlocale API. Unlike
wxLocale it doesn't provide any non-trivial operations but
simply provides a portable wrapper for POSIX @c locale_t type. It exists
solely to be provided as an argument to various @c wxFoo_l() functions
which are the extensions of the standard locale-dependent functions (hence the
name xlocale). These functions do exactly the same thing as the corresponding
standard @c foo() except that instead of using the global program locale
they use the provided wxXLocale object. For example, if the user runs the
program in French locale, the standard @c printf() function will output
floating point numbers using decimal comma instead of decimal period. If the
program needs to format a floating-point number in a standard format it can
use @c wxPrintf_l(wxXLocale::GetCLocale(), "%g", number) to do it.
Conversely, if a program wanted to output the number in French locale, even if
the current locale is different, it could use wxXLocale(wxLANGUAGE_FRENCH).
*/
static wxXLocale& GetCLocale();
/**
Returns @true if this object is initialized, i.e. represents a valid locale
or
@false otherwise.
or @false otherwise.
*/
bool IsOk() const;
/**
Currently the following @c _l-functions are available:
Character classification functions: @c wxIsxxx_l(), e.g.
@c wxIsalpha_l(), @c wxIslower_l() and all the others.
Character transformation functions: @c wxTolower_l() and
@c wxToupper_l()
We hope to provide many more functions (covering numbers, time and formatted
IO) in the near future.
@see wxLocale
*/
};