Class: Wx::AUI::AuiToolBarEvent

Inherits:

NotifyEvent

• Object
• Object
• Event
• CommandEvent
• NotifyEvent
• Wx::AUI::AuiToolBarEvent

Defined in:

lib/wx/doc/gen/aui/aui_tool_bar_event.rb

Overview

AuiToolBarEvent is used for the events generated by AuiToolBar.

Category: Window Docking (wxAUI), Events

Requires:

• USE_AUI

Instance Method Summary

• #get_click_point ⇒ Wx::Point (also: #click_point)

  Returns the point where the user clicked with the mouse.

• #get_item_rect ⇒ Wx::Rect (also: #item_rect)

  Returns the AuiToolBarItem rectangle bounding the mouse click point.

• #get_tool_id ⇒ Integer (also: #tool_id)

  Returns the AuiToolBarItem identifier.

• #initialize(*args) ⇒ AuiToolBarEvent constructor

  A new instance of AuiToolBarEvent.

• #is_drop_down_clicked ⇒ Boolean (also: #drop_down_clicked?)

  Returns whether the drop down menu has been clicked.

• #set_click_point(p) ⇒ void (also: #click_point=)
• #set_drop_down_clicked(c) ⇒ void (also: #drop_down_clicked=)
• #set_item_rect(r) ⇒ void (also: #item_rect=)
• #set_tool_id(toolId) ⇒ void (also: #tool_id=)

Methods inherited from NotifyEvent

#allow, #is_allowed, #veto

Methods inherited from CommandEvent

#client_data, #client_data=, #get_client_data, #get_client_object, #get_int, #get_selection, #get_string, #is_checked, #is_selection, #set_client_data, #set_client_object, #set_extra_long, #set_int, #set_string

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(commandType = Wx::EVT_NULL, winId = 0) ⇒ Wx::AUI::AuiToolBarEvent #initialize(c) ⇒ Wx::AUI::AuiToolBarEvent

Returns a new instance of AuiToolBarEvent.

Overloads:

• #initialize(commandType = Wx::EVT_NULL, winId = 0) ⇒ Wx::AUI::AuiToolBarEvent

  Parameters:

  • commandType (Wx::HTML::SimpleHtmlListBox::EventType) (defaults to: Wx::EVT_NULL)
  • winId (Integer) (defaults to: 0)
• #initialize(c) ⇒ Wx::AUI::AuiToolBarEvent

  Parameters:

  • c (Wx::AUI::AuiToolBarEvent)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 154

def initialize(*args) end

Instance Method Details

#get_click_point ⇒ Wx::Point Also known as: click_point

Returns the point where the user clicked with the mouse.

Returns:

• (Wx::Point)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 163

def get_click_point; end

#get_item_rect ⇒ Wx::Rect Also known as: item_rect

Returns the Wx::AUI::AuiToolBarItem rectangle bounding the mouse click point.

Returns:

• (Wx::Rect)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 168

def get_item_rect; end

#get_tool_id ⇒ Integer Also known as: tool_id

Returns the Wx::AUI::AuiToolBarItem identifier.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 173

def get_tool_id; end

#is_drop_down_clicked ⇒ Boolean Also known as: drop_down_clicked?

Returns whether the drop down menu has been clicked.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 158

def is_drop_down_clicked; end

#set_click_point(p) ⇒ void Also known as: click_point=

This method returns an undefined value.

Parameters:

• p (Array(Integer, Integer), Wx::Point)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 183

def set_click_point(p) end

#set_drop_down_clicked(c) ⇒ void Also known as: drop_down_clicked=

This method returns an undefined value.

Parameters:

• c (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 178

def set_drop_down_clicked(c) end

#set_item_rect(r) ⇒ void Also known as: item_rect=

This method returns an undefined value.

Parameters:

• r (Wx::Rect)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 188

def set_item_rect(r) end

#set_tool_id(toolId) ⇒ void Also known as: tool_id=

This method returns an undefined value.

Parameters:

• toolId (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_event.rb', line 193

def set_tool_id(toolId) end