wxWidgets: wxGridRangeSelectEvent Class Reference

| Version: 3.1.7

Loading...
Searching...
No Matches
Public Member Functions | List of all members
wxGridRangeSelectEvent Class Reference
Class List by Category » Grid Related Classes | Class List by Category » Events

`#include </cygdrive/c/Users/Hamis/Cygwin-packaging/wxWidgets3.1/wxWidgets3.1-3.1.7-1.x86_64/src/wxWidgets-3.1.7/interface/wx/grid.h>`

Inheritance diagram for wxGridRangeSelectEvent:
[legend]

## Detailed Description

Events of this class notify about a range of cells being selected.

When the user uses the mouse for selection, one or more `SELECTING` events are generated first, with `SELECTED` event generated at the end, when selection is final. This allows the application to handle either the `SELECTING` events if it needs to update its state in real-time, as the selection changes, or just the final `SELECTED` event, if updating its state on every selection change would be too time-consuming.

Note that if the user performs the selection from keyboard, `SELECTING` events are not generated at all, so `SELECTED` event still must be handled.

Finally, contrary to most of the other events with the name ending in "ing", `SELECTING` event can not be vetoed.

## Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxGridRangeSelectEvent& event)

Event macros:

- EVT_GRID_RANGE_SELECTING(func):
  The user is selecting a group of contiguous cells. Processes a `wxEVT_GRID_RANGE_SELECTING` event type. This event is available in wxWidgets 3.1.5 and later only.
- EVT_GRID_CMD_RANGE_SELECTING(id, func):
  The user is selecting a group of contiguous cells; variant taking a window identifier. Processes a `wxEVT_GRID_RANGE_SELECTING` event type. This event is available in wxWidgets 3.1.5 and later only.
- EVT_GRID_RANGE_SELECTED(func):
  The user selected a group of contiguous cells. Processes a `wxEVT_GRID_RANGE_SELECTED` event type. This event is available in wxWidgets 3.1.5 and later only and was called `wxEVT_GRID_RANGE_SELECT` in the previous versions.
- EVT_GRID_CMD_RANGE_SELECTED(id, func):
  The user selected a group of contiguous cells; variant taking a window identifier. Processes a `wxEVT_GRID_RANGE_SELECTED` event type. This event is available in wxWidgets 3.1.5 and later only and was called `wxEVT_GRID_CMD_RANGE_SELECT` in the previous versions.

##

Library: wxCore
Category: Grid Related Classes, Events

## Public Member Functions
| wxGridRangeSelectEvent ()
| Default constructor.
| wxGridRangeSelectEvent (int id, wxEventType type, wxObject *obj, const wxGridCellCoords &topLeft, const wxGridCellCoords &bottomRight, bool sel=true, const wxKeyboardState &kbd=wxKeyboardState())
| Constructor for initializing all event attributes.
bool | AltDown () const
| Returns true if the Alt key was down at the time of the event.
bool | ControlDown () const
| Returns true if the Control key was down at the time of the event.
wxGridCellCoords | GetBottomRightCoords () const
| Top left corner of the rectangular area that was (de)selected.
int | GetBottomRow () const
| Bottom row of the rectangular area that was (de)selected.
int | GetLeftCol () const
| Left column of the rectangular area that was (de)selected.
int | GetRightCol () const
| Right column of the rectangular area that was (de)selected.
wxGridCellCoords | GetTopLeftCoords () const
| Top left corner of the rectangular area that was (de)selected.
int | GetTopRow () const
| Top row of the rectangular area that was (de)selected.
bool | MetaDown () const
| Returns true if the Meta key was down at the time of the event.
bool | Selecting () const
| Returns true if the area was selected, false otherwise.
bool | ShiftDown () const
| Returns true if the Shift key was down at the time of the event.
Public Member Functions inherited from wxNotifyEvent
| wxNotifyEvent (wxEventType eventType=wxEVT_NULL, int id=0)
| Constructor (used internally by wxWidgets only).
void | Allow ()
| This is the opposite of Veto(): it explicitly allows the event to be processed.
bool | IsAllowed () const
| Returns true if the change is allowed (Veto() hasn't been called) or false otherwise (if it was).
void | Veto ()
| Prevents the change announced by this event from happening.
Public Member Functions inherited from wxCommandEvent
| wxCommandEvent (wxEventType commandEventType=wxEVT_NULL, int id=0)
| Constructor.
void * | GetClientData () const
| Returns client data pointer for a listbox or choice selection event (not valid for a deselection).
wxClientData * | GetClientObject () const
| Returns client object pointer for a listbox or choice selection event (not valid for a deselection).
long | GetExtraLong () const
| Returns extra information dependent on the event objects type.
int | GetInt () const
| Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.
int | GetSelection () const
| Returns item index for a listbox or choice selection event (not valid for a deselection).
wxString | GetString () const
| Returns item string for a listbox or choice selection event.
bool | IsChecked () const
| This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one.
bool | IsSelection () const
| For a listbox or similar event, returns true if it is a selection, false if it is a deselection.
void | SetClientData (void *clientData)
| Sets the client data for this event.
void | SetClientObject (wxClientData *clientObject)
| Sets the client object for this event.
void | SetExtraLong (long extraLong)
| Sets the m_extraLong member.
void | SetInt (int intCommand)
| Sets the m_commandInt member.
void | SetString (const wxString &string)
| Sets the m_commandString member.
Public Member Functions inherited from wxEvent
| wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
| Constructor.
virtual wxEvent * | Clone () const =0
| Returns a copy of the event.
wxObject * | GetEventObject () const
| Returns the object (usually a window) associated with the event, if any.
wxEventType | GetEventType () const
| Returns the identifier of the given event type, such as `wxEVT_BUTTON`.
virtual wxEventCategory | GetEventCategory () const
| Returns a generic category for this event.
int | GetId () const
| Returns the identifier associated with this event, such as a button command id.
wxObject * | GetEventUserData () const
| Return the user data associated with a dynamically connected event handler.
bool | GetSkipped () const
| Returns true if the event handler should be skipped, false otherwise.
long | GetTimestamp () const
| Gets the timestamp for the event.
bool | IsCommandEvent () const
| Returns true if the event is or is derived from wxCommandEvent else it returns false.
void | ResumePropagation (int propagationLevel)
| Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation).
void | SetEventObject (wxObject *object)
| Sets the originating object.
void | SetEventType (wxEventType type)
| Sets the event type.
void | SetId (int id)
| Sets the identifier associated with this event, such as a button command id.
void | SetTimestamp (long timeStamp=0)
| Sets the timestamp for the event.
bool | ShouldPropagate () const
| Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.
void | Skip (bool skip=true)
| This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns.
int | StopPropagation ()
| Stop the event from propagating to its parent window.
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data.
| wxObject (const wxObject &other)
| Copy ctor.
virtual | ~wxObject ()
| Destructor.
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class.
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj.
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone.
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer.
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data.
void | UnShare ()
| This is the same of AllocExclusive() but this method is public.
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined.
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined.

## Additional Inherited Members
Protected Member Functions inherited from wxObject
void | AllocExclusive ()
| Ensure that this object's data is not shared with any other object.
virtual wxObjectRefData * | CreateRefData () const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.
Protected Attributes inherited from wxEvent
int | m_propagationLevel
| Indicates how many levels the event can propagate.
Protected Attributes inherited from wxObject
wxObjectRefData * | m_refData
| Pointer to an object which is the object's reference-counted data.

## Constructor & Destructor Documentation

## ◆ wxGridRangeSelectEvent() [1/2]

wxGridRangeSelectEvent::wxGridRangeSelectEvent | ( |  | ) |

Default constructor.

## ◆ wxGridRangeSelectEvent() [2/2]

wxGridRangeSelectEvent::wxGridRangeSelectEvent | ( | int | id,
|  | wxEventType | type,
|  | wxObject * | obj,
|  | const wxGridCellCoords & | topLeft,
|  | const wxGridCellCoords & | bottomRight,
|  | bool | sel = true,
|  | const wxKeyboardState & | kbd = wxKeyboardState() )

Constructor for initializing all event attributes.

## Member Function Documentation

## ◆ AltDown()

bool wxGridRangeSelectEvent::AltDown | ( |  | ) | const

Returns true if the Alt key was down at the time of the event.

## ◆ ControlDown()

bool wxGridRangeSelectEvent::ControlDown | ( |  | ) | const

Returns true if the Control key was down at the time of the event.

## ◆ GetBottomRightCoords()

wxGridCellCoords wxGridRangeSelectEvent::GetBottomRightCoords | ( |  | ) | const

Top left corner of the rectangular area that was (de)selected.

## ◆ GetBottomRow()

int wxGridRangeSelectEvent::GetBottomRow | ( |  | ) | const

Bottom row of the rectangular area that was (de)selected.

## ◆ GetLeftCol()

int wxGridRangeSelectEvent::GetLeftCol | ( |  | ) | const

Left column of the rectangular area that was (de)selected.

## ◆ GetRightCol()

int wxGridRangeSelectEvent::GetRightCol | ( |  | ) | const

Right column of the rectangular area that was (de)selected.

## ◆ GetTopLeftCoords()

wxGridCellCoords wxGridRangeSelectEvent::GetTopLeftCoords | ( |  | ) | const

Top left corner of the rectangular area that was (de)selected.

## ◆ GetTopRow()

int wxGridRangeSelectEvent::GetTopRow | ( |  | ) | const

Top row of the rectangular area that was (de)selected.

## ◆ MetaDown()

bool wxGridRangeSelectEvent::MetaDown | ( |  | ) | const

Returns true if the Meta key was down at the time of the event.

## ◆ Selecting()

bool wxGridRangeSelectEvent::Selecting | ( |  | ) | const

Returns true if the area was selected, false otherwise.

## ◆ ShiftDown()

bool wxGridRangeSelectEvent::ShiftDown | ( |  | ) | const

Returns true if the Shift key was down at the time of the event.