class Gio::SimpleAction

Overview

A #GSimpleAction is the obvious simple implementation of the #GAction interface. This is the easiest way to create an action for purposes of adding it to a #GSimpleActionGroup.

See also #Gtk::Action.

Included Modules

Defined in:

lib/gi-crystal/src/auto/gio-2.0/simple_action.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gio::Action

activate(parameter : _ | Nil) : Nil activate, change_state(value : _) : Nil change_state, enabled : Bool enabled, enabled? : Bool enabled?, name : String name, name? : String | Nil name?, parameter_type : GLib::VariantType | Nil parameter_type, parse_detailed_name(detailed_name : String, action_name : String, target_value : _) : Bool parse_detailed_name, state : GLib::Variant | Nil state, state_hint : GLib::Variant | Nil state_hint, state_type : GLib::VariantType | Nil state_type, to_unsafe to_unsafe

Constructor methods inherited from module Gio::Action

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gio::Action

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type, name_is_valid(action_name : String) : Bool name_is_valid, print_detailed_name(action_name : String, target_value : _ | Nil) : String print_detailed_name

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new(name : String, parameter_type : GLib::VariantType | Nil) : self #

Creates a new action.

The created action is stateless. See g_simple_action_new_stateful() to create an action that has state.


[View source]
def self.new #

Initialize a new SimpleAction.


[View source]
def self.new(*, enabled : Bool | Nil = nil, name : String | Nil = nil, parameter_type : GLib::VariantType | Nil = nil, state : GLib::Variant | Nil = nil, state_type : GLib::VariantType | Nil = nil) #

[View source]
def self.new_stateful(name : String, parameter_type : GLib::VariantType | Nil, state : _) : self #

Creates a new stateful action.

All future state values must have the same #GVariantType as the initial state.

If the state #GVariant is floating, it is consumed.


[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def activate_signal #

[View source]
def change_state_signal #

[View source]
def enabled=(enabled : Bool) : Nil #

Sets the action as enabled or not.

An action must be enabled in order to be activated or in order to have its state changed from outside callers.

This should only be called by the implementor of the action. Users of the action should not attempt to modify its enabled flag.


[View source]
def enabled? : Bool #

[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String #

[View source]
def name=(value : String) : String #

[View source]
def name=(value : Nil) : Nil #

Set #name property to nil.


[View source]
def name? : String | Nil #

Same as #name, but can return nil.


[View source]
def parameter_type : GLib::VariantType | Nil #

[View source]
def parameter_type=(value : GLib::VariantType | Nil) : GLib::VariantType | Nil #

[View source]
def state : GLib::Variant | Nil #

[View source]
def state=(value : GLib::Variant | Nil) : GLib::Variant | Nil #

[View source]
def state=(value : _) : Nil #

Sets the state of the action.

This directly updates the 'state' property to the given value.

This should only be called by the implementor of the action. Users of the action should not attempt to directly modify the 'state' property. Instead, they should call g_action_change_state() to request the change.

If the value GVariant is floating, it is consumed.


[View source]
def state_hint=(state_hint : _ | Nil) : Nil #

Sets the state hint for the action.

See g_action_get_state_hint() for more information about action state hints.


[View source]
def state_type : GLib::VariantType | Nil #

[View source]