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

added wxRearrange{List,Ctrl,Dialog} and use it in wxHeaderCtrl and wxGrid to provide a way to interactively customize the columns

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57379 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-12-16 23:56:56 +00:00
parent 74a98b9938
commit af67f39da8
18 changed files with 1094 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
interface/wx/headerctrl.h
View File

@@ -14,13 +14,13 @@
wxHeaderCtrl is the control containing the column headings which is usually
used for display of tabular data.
It is used as part of wxGrid, in wxDataViewCtrl and in the report view of
wxListCtrl but can be also used independently.
In general this class is meant to be used as part of another
control which already stores the column information somewhere as it can't
be used directly: instead you need to inherit from it and implement the
GetColumn() method to provide column information. See wxHeaderCtrlSimple
for a concrete control class which can be used directly.
It is used as part of wxGrid, in generic version wxDataViewCtrl and report
view of wxListCtrl but can be also used independently. In general this
class is meant to be used as part of another control which already stores
the column information somewhere as it can't be used directly: instead you
need to inherit from it and implement the GetColumn() method to provide
column information. See wxHeaderCtrlSimple for a concrete control class
which can be used directly.
In addition to labeling the columns, the control has the following
features:
@@ -56,6 +56,11 @@
@style{wxHD_ALLOW_REORDER}
If this style is specified (it is by default), the user can reorder
the control columns by dragging them.
@style{wxHD_ALLOW_HIDE}
If this style is specified, the control shows a popup menu allowing the
user to change the columns visibility on right mouse click. Notice that
the program can always hide or show the columns, this style only
affects the users capability to do it.
@style{wxHD_DEFAULT_STYLE}
Symbolic name for the default control style, currently equal to
@c wxHD_ALLOW_REORDER.
@@ -300,19 +305,45 @@ public:
Show the popup menu allowing the user to show or hide the columns.
This functions shows the popup menu containing all columns with check
marks for the ones which are currently shown at the current mouse
position. It is meant to be called from EVT_HEADER_RIGHT_CLICK handler
and should toggle the visibility of the n-th column if the function
returns valid column index and not wxID_NONE which is returned if the
user cancels the menu.
marks for the ones which are currently shown and allows the user to
check or uncheck them to toggle their visibility. It is called from the
default EVT_HEADER_RIGHT_CLICK handler for the controls which have
wxHD_ALLOW_HIDE style. And if the column has wxHD_ALLOW_REORDER style
as well, the menu also contains an item to customize the columns shown
using which results in ShowCustomizeDialog() being called, please see
its description for more details.
If a column was toggled, UpdateColumnVisibility() virtual function is
called so it must be implemented for the controls with wxHD_ALLOW_HIDE
style or if you call this function explicitly.
@param pt
The position of the menu, in the header window coordinates.
@param title
The title for the menu if not empty.
@return
A valid column index or wxID_NONE if the user didn't select any
column.
@true if a column was shown or hidden or @false if nothing was
done, e.g. because the menu was cancelled.
*/
int ShowColumnsMenu(const wxString& title = wxString());
int ShowColumnsMenu(const wxPoint& pt, const wxString& title = wxString());
/**
Show the column customization dialog.
This function displays a modal dialog containing the list of all
columns which the user can use to reorder them as well as show or hide
individual columns.
If the user accepts the changes done in the dialog, the virtual
methods UpdateColumnVisibility() and UpdateColumnsOrder() will be
called so they must be overridden in the derived class if this method
is ever called. Please notice that the user will be able to invoke it
interactively from the header popup menu if the control has both
wxHD_ALLOW_HIDE and wxHD_ALLOW_REORDER styles.
@see wxRearrangeDialog
*/
bool ShowCustomizeDialog();
protected:
/**
@@ -325,6 +356,50 @@ protected:
*/
virtual wxHeaderColumnBase& GetColumn(unsigned int idx) = 0;
/**
Method called when the column visibility is changed by the user.
This method is called from ShowColumnsMenu() or ShowCustomizeDialog()
when the user interactively hides or shows a column. A typical
implementation will simply update the internally stored column state.
Notice that there is no need to call UpdateColumn() from this method as
it is already done by wxHeaderCtrl itself.
The base class version doesn't do anything and must be overridden if
this method is called.
@param idx
The index of the column whose visibility was toggled.
@param show
The new visibility value, @true if the column is now shown or
@false if it is not hidden.
*/
virtual void UpdateColumnVisibility(unsigned int idx, bool show);
/**
Method called when the columns order is changed in the customization
dialog.
This method is only called from ShowCustomizeDialog() when the user
changes the order of columns. In particular it is @em not called if a
single column changes place because the user dragged it to the new
location, the EVT_HEADER_END_REORDER event handler should be used to
react to this.
A typical implementation in a derived class will update the display
order of the columns in the associated control, if any. Notice that
there is no need to call SetColumnsOrder() from it as wxHeaderCtrl does
it itself.
The base class version doesn't do anything and must be overridden if
this method is called.
@param order
The new column order. This array uses the same convention as
SetColumnsOrder().
*/
virtual void UpdateColumnsOrder(const wxArrayInt& order);
/**
Method which may be implemented by the derived classes to allow double
clicking the column separator to resize the column to fit its contents.

305
interface/wx/rearrangectrl.h Normal file
View File

@@ -0,0 +1,305 @@
/////////////////////////////////////////////////////////////////////////////
// Name: wx/rearrangectrl.h
// Purpose: interface of wxRearrangeList
// Author: Vadim Zeitlin
// Created: 2008-12-15
// RCS-ID: $Id$
// Copyright: (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxRearrangeList
A listbox-like control allowing the user to rearrange the items and to
enable or disable them.
This class allows to change the order of the items shown in it as well as
to check or uncheck them individually. The data structure used to allow
this is the order array which contains the items indices indexed by their
position with an added twist that the unchecked items are represented by
the bitwise complement of the corresponding index (for any architecture
using two's complement for negative numbers representation (i.e. just about
any at all) this means that a checked item N is represented by -N-1 in
unchecked state). In practice this means that you must apply the C bitwise
complement operator when constructing the order array, e.g.
@code
wxArrayInt order;
order.push_back(0); // checked item #0
order.push_back(~1); // unchecked item #1
@endcode
So, for example, the array order [1 -3 0] used in conjunction with the
items array ["first", "second", "third"] means that the items order is
"second", "third", "first" and the "third" item is unchecked while the
other two are checked.
This convention is used both for the order argument of the control ctor or
Create() and for the array returned from GetCurrentOrder().
Usually this control will be used together with other controls allowing to
move the items around in it interactively. The simplest possible solution
is to use wxRearrangeCtrl which combines it with two standard buttons to
move the current item up or down.
@library{wxcore}
@category{ctrl}
*/
class wxRearrangeList : public wxCheckListBox
{
public:
/**
Default constructor.
Create() must be called later to effectively create the control.
*/
wxRearrangeList();
/**
Constructor really creating the control.
Please see Create() for the parameters description.
*/
wxRearrangeList(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
const wxArrayInt& order,
const wxArrayString& items,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxRearrangeListNameStr);
/**
Effectively creates the window for an object created using the default
constructor.
This function is very similar to wxCheckListBox::Create() except that
it has an additional parameter specifying the initial order of the
items. Please see the class documentation for the explanation of the
conventions used by the @a order argument.
@param parent
The parent window, must be non-@NULL.
@param id
The window identifier.
@param pos
The initial window position.
@param size
The initial window size.
@param order
Array specifying the initial order of the items in @a items array.
@param items
The items to display in the list.
@param style
The control style, there are no special styles for this class but
the base class styles can be used here.
@param validator
Optional window validator.
@param name
Optional window name.
*/
bool Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
const wxArrayInt& order,
const wxArrayString& items,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxRearrangeListNameStr);
/**
Return the current order of the items.
The order may be different from the one passed to the constructor if
MoveCurrentUp() or MoveCurrentDown() were called.
*/
const wxArrayInt& GetCurrentOrder() const;
/**
Return @true if the currently selected item can be moved up.
This function is useful for EVT_UPDATE_UI handler for the standard "Up"
button often used together with this control and wxRearrangeCtrl uses
it in this way.
@return
@true if the currently selected item can be moved up in the
listbox, @false if there is no selection or the current item is the
first one.
@see CanMoveCurrentDown()
*/
bool CanMoveCurrentUp() const;
/**
Return @true if the currently selected item can be moved down.
@see CanMoveCurrentUp()
*/
bool CanMoveCurrentDown() const;
/**
Move the currently selected item one position above.
This method is useful to implement the standard "Up" button behaviour
and wxRearrangeCtrl uses it for this.
@return
@true if the item was moved or @false if this couldn't be done.
@see MoveCurrentDown()
*/
bool MoveCurrentUp();
/**
Move the currently selected item one position below.
@see MoveCurrentUp()
*/
bool MoveCurrentDown();
};
/**
@class wxRearrangeCtrl
A composite control containing a wxRearrangeList and the buttons allowing
to move the items in it.
This control is in fact a panel containing the wxRearrangeList control and
the "Up" and "Down" buttons to move the currently selected item up or down.
It is used as the main part of a wxRearrangeDialog.
@library{wxcore}
@category{ctrl}
*/
class wxRearrangeCtrl
{
public:
/**
Default constructor.
Create() must be called later to effectively create the control.
*/
wxRearrangeCtrl();
/**
Constructor really creating the control.
Please see Create() for the parameters description.
*/
wxRearrangeCtrl(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
const wxArrayInt& order,
const wxArrayString& items,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxRearrangeListNameStr);
/**
Effectively creates the window for an object created using the default
constructor.
The parameters of this method are the same as for
wxRearrangeList::Create().
*/
bool Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
const wxArrayInt& order,
const wxArrayString& items,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxRearrangeListNameStr);
/**
Return the listbox which is the main part of this control.
*/
wxRearrangeList *GetList() const;
};
/**
@class wxRearrangeDialog
A dialog allowing the user to rearrange the specified items.
This dialog can be used to allow the user to modify the order of the items
and to enable or disable them individually. For example:
@code
wxArrayString items;
items.push_back("meat");
items.push_back("fish");
items.push_back("fruits");
items.push_back("beer");
wxArrayInt order;
order.push_back(3);
order.push_back(0);
order.push_back(1);
order.push_back(2);
wxRearrangeDialog dlg(NULL,
"You can also uncheck the items you don't like "
"at all.",
"Sort the items in order of preference",
order, items);
if ( dlg.ShowModal() == wxID_OK ) {
order = dlg.GetOrder();
for ( size_t n = 0; n < order.size(); n++ ) {
if ( order[n] >= 0 ) {
wxLogMessage("Your most preferred item is \"%s\"",
items[order[n]]);
break;
}
}
}
@endcode
@library{wxcore}
@category{cmndlg}
*/
class wxRearrangeDialog
{
public:
/**
Constructor creating the dialog.
@param parent
The dialog parent, possibly @NULL.
@param message
The message shown inside the dialog itself, above the items list.
@param title
The title of the dialog.
@param order
The initial order of the items in the convention used by
wxRearrangeList.
@param items
The items to show in the dialog.
@param pos
Optional dialog position.
@param name
Optional dialog name.
*/
wxRearrangeDialog(wxWindow *parent,
const wxString& message,
const wxString& title,
const wxArrayInt& order,
const wxArrayString& items,
const wxPoint& pos = wxDefaultPosition,
const wxString& name = wxRearrangeDialogNameStr);
/**
Return the array describing the order of items after it was modified by
the user.
Please notice that the array will contain negative items if any items
were unchecked. See wxRearrangeList for more information about the
convention used for this array.
*/
wxArrayInt GetOrder() const;
};