Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EmacsPushButton documentation (new_file) #54

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions HelpSource/Classes/EmacsPushButton.schelp
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
ITLE:: EmacsPushButton
SUMMARY:: Push button widget
CATEGORIES:: Frontends>Emacs
RELATED:: Classes/EmacsBuffer, Classes/EmacsWidget, Classes/EmacsButton

DESCRIPTION::
An Emacs button widget with one state.

CLASSMETHODS::

METHOD:: new

ARGUMENT:: buffer
An link::Classes/EmacsBuffer:: into which the widget should be placed. The widget will be positioned at the current cursor location.

ARGUMENT:: tag
Button label.


INSTANCEMETHODS::

METHOD:: action
Get/set the button press action;


EXAMPLES::

code::
p = EmacsBuffer.new; // create an Emacs's buffer for the widget
p.front; // Bring it up

b = EmacsPushButton( p, "I am a push button" ).action_( { "Do it!".postln; } );

b.action = { "New cool action".postln} // action could be changed

// inherited from EmacsWidget
b.id
b.type
b.enabled // true
b.enabled = false
b.enabled = true

p.free; // close the EmacsBuffer
::