檢視原始碼 wxCommandEvent (wx v2.4.3)

這個事件類別包含關於命令事件的資訊,這些事件源自於各種簡單的控制項。

請注意,wxCommandEvents 和衍生自 wxCommandEvent 的事件類別,預設與其他衍生自 wxEvent 的類別不同,會從來源視窗(發出事件的視窗)向上傳播到第一個處理該事件的父視窗。請務必閱讀 overview_events_propagation。

更複雜的控制項,例如 wxTreeCtrl,有單獨的命令事件類別。

這個類別是衍生而來,可以使用以下類別的函式:

wxWidgets 文件:wxCommandEvent

事件

使用 wxEvtHandler:connect/3wxCommandEventType 來訂閱此類型的事件。

摘要

函式

傳回清單方塊或選項選擇事件的客戶端物件指標(不適用於取消選取)。

傳回依賴於事件物件類型的額外資訊。

傳回對應於清單方塊、選項或單選按鈕選擇的整數識別符(僅在事件為選擇而非取消選擇時),或表示核取方塊值的布林值。

傳回清單方塊或選項選擇事件的項目索引(不適用於取消選取)。

傳回清單方塊或選項選擇事件的項目字串。

此方法可用於核取方塊和選單事件:對於核取方塊,此方法在選取事件時傳回 true,在取消選取事件時傳回 false。

對於清單方塊或類似事件,如果為選取則傳回 true,如果為取消選取則傳回 false。

設定 m_commandInt 成員。

設定 m_commandString 成員。

類型

-type wxCommand() ::
          #wxCommand{type :: wxCommandEvent:wxCommandEventType(),
                     cmdString :: unicode:chardata(),
                     commandInt :: integer(),
                     extraLong :: integer()}.
-type wxCommandEvent() :: wx:wx_object().
-type wxCommandEventType() ::
          command_button_clicked | command_checkbox_clicked | command_choice_selected |
          command_listbox_selected | command_listbox_doubleclicked | command_text_updated |
          command_text_enter | text_maxlen | command_menu_selected | command_slider_updated |
          command_radiobox_selected | command_radiobutton_selected | command_scrollbar_updated |
          command_vlbox_selected | command_combobox_selected | combobox_dropdown | combobox_closeup |
          command_tool_rclicked | command_tool_enter | tool_dropdown | command_checklistbox_toggled |
          command_togglebutton_clicked | command_left_click | command_left_dclick |
          command_right_click | command_set_focus | command_kill_focus | command_enter |
          notification_message_click | notification_message_dismissed | notification_message_action.

函式

-spec getClientData(This) -> term() when This :: wxCommandEvent().

傳回清單方塊或選項選擇事件的客戶端物件指標(不適用於取消選取)。

-spec getExtraLong(This) -> integer() when This :: wxCommandEvent().

傳回依賴於事件物件類型的額外資訊。

如果事件來自清單方塊選擇,則它是一個布林值,決定事件是選擇(true)還是取消選擇(false)。清單方塊取消選擇僅在多重選擇方塊中發生,在這種情況下,索引和字串值是不確定的,應用程式必須檢查清單方塊。

-spec getInt(This) -> integer() when This :: wxCommandEvent().

傳回對應於清單方塊、選項或單選按鈕選擇的整數識別符(僅在事件為選擇而非取消選擇時),或表示核取方塊值的布林值。

對於選單項目,如果項目不可核取,則此方法傳回 -1,如果項目可核取,則傳回布林值 (true 或 false),表示項目的新狀態。

-spec getSelection(This) -> integer() when This :: wxCommandEvent().

傳回清單方塊或選項選擇事件的項目索引(不適用於取消選取)。

-spec getString(This) -> unicode:charlist() when This :: wxCommandEvent().

傳回清單方塊或選項選擇事件的項目字串。

如果一個或多個項目已被取消選擇,則傳回第一個取消選擇的項目的索引。如果某些項目被選取,而其他項目同時被取消選取,則會傳回第一個選取項目的索引。

-spec isChecked(This) -> boolean() when This :: wxCommandEvent().

此方法可用於核取方塊和選單事件:對於核取方塊,此方法在選取事件時傳回 true,在取消選取事件時傳回 false。

對於選單事件,此方法指示選單項目是否剛被核取或取消核取(因此僅對可核取的選單項目有意義)。

請注意,此方法目前無法與 wxCheckListBox 一起使用。

-spec isSelection(This) -> boolean() when This :: wxCommandEvent().

對於清單方塊或類似事件,如果為選取則傳回 true,如果為取消選取則傳回 false。

如果某些項目被選取而其他項目同時被取消選取,則會傳回 true。

此函式的連結

setInt(This, IntCommand)

檢視原始碼
-spec setInt(This, IntCommand) -> ok when This :: wxCommandEvent(), IntCommand :: integer().

設定 m_commandInt 成員。

此函式的連結

setString(This, String)

檢視原始碼
-spec setString(This, String) -> ok when This :: wxCommandEvent(), String :: unicode:chardata().

設定 m_commandString 成員。