Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Add event subscription methods for Editor and associated classes #3456

Merged
merged 59 commits into from
Sep 9, 2014
Merged

Add event subscription methods for Editor and associated classes #3456

merged 59 commits into from
Sep 9, 2014

Conversation

nathansobo
Copy link
Contributor

  • Add event subscription methods
    • 🔧 Editor
    • Cursor
    • Selection
    • Decoration
    • DisplayBuffer
    • TokenizedBuffer
  • Deprecate ::on
    • Editor
    • Cursor
    • Selection
    • Decoration
    • DisplayBuffer
    • TokenizedBuffer
  • Document new methods

Notes

  • We should drop events on editor that can be replaced by methods on Cursor, Selection, Decoration
  • Don't forget to dispose emitter instances on destruction of the owner

@benogle benogle self-assigned this Sep 4, 2014
@benogle
Copy link
Contributor

benogle commented Sep 4, 2014

Note to peeps: i'm taking this over now

Nathan Sobo added 20 commits September 5, 2014 11:36
@benogle
Add Editor::onDidChangeTitle
b731f7c
@benogle
Add Editor::onDidChangePath
133f3f4
@benogle
Add Editor::onDidChangeModified
d15d157
@benogle
Rename softWrap to softWrapped
965afc2 
Our new pattern for booleans is to have ::set and ::is, and that means
the property name needs to be in passive voice for ::is to make sense.
This is in preparation for adding a new change observation method.

* ::setSoftWrapped
* ::isSoftWrapped
* ::toggleSoftWrapped
@benogle
Add Editor::onDidChangeSoftWrapped
3e260ee
@benogle
Add ::onDidChangeGrammar to Editor, DisplayBuffer, and TokenizedBuffer
1c95a55
@benogle
Add Editor::onDidStopChanging which delegates to TextBuffer
5a02303
@benogle
Add Editor::onDidConflict
63c9da0
@benogle
Add Editor::onWill/DidInsertText
05ea381
@benogle
Add Editor::onDidMoveCursor
2a81687
@benogle
Remove ‘cursors-moved’ event
161edfd 
It event was not document only being used in EditorComponent. Due to
our batching strategy, it’s fine to respond to individual
::onDidMoveCursor events.
@benogle
Add Editor::onDidAddCursor
3b6e40f
@benogle
Add Editor::onDidRemoveCursor
e77b4a5
@benogle
Eliminate Editor::onDidMoveCursor
3e77b9b 
If you want to know if a cursor moved, subscribe to the cursor.
@benogle
Add Editor::onDidAdd/RemoveSelection
651eb78 
Also update EditorComponent to use the new ::onDidAddSelection method.
@benogle
Add DisplayBufferMarker::onDidChange and ::onDidDestroy
1131b33
@benogle
Remove specs for ::onDidMoveCursor, which was removed
c69b5fc
@benogle
Deprecate DisplayBufferMarker::on
6bd8702
@benogle
Add Cursor::onDidChangePosition and ::onDidDestroy and deprecate ::on
5668702
@benogle
Add Selection::onDidChangeRange and ::onDidDestroy and deprecate ::on
6ad9531
@benogle benogle force-pushed the ns-editor-event-methods branch from 79a0626 to 6ad9531 Compare September 5, 2014 18:39
@batjko
Copy link
Contributor

batjko commented Sep 6, 2014

Guys, this is awesome stuff!
Do you think you one of you could write a blog post on the reasoning behind changing the event logic and the benefits of doing it this way etc?

This is the kind of stuff that can be extremely educational for people, as well as just interesting from a behind-the-scenes kind of perspective.

nathansobo
nathansobo reviewed Sep 6, 2014
View reviewed changes
src/decoration.coffee
# * `newParams` {Object} eg. `{type: 'gutter', class: 'my-new-class'}`
update: (newParams) ->
# * `newProperties` {Object} eg. `{type: 'gutter', class: 'my-new-class'}`
setProperties: (newProperties) ->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@benogle
Copy link
Contributor

benogle commented Sep 8, 2014

@batjko we should do a blog post about this. We'd like to do a post on each large unit of API work.

benogle added 17 commits September 8, 2014 16:04
@benogle
Add Editor::onDidChangeScreenLines
8aa1784
@benogle
Add deprecation warnings for all the other converted events
efea168
@benogle
Fix deprecation warning
b6a9e1b
@benogle
💄 consistency
6f9f087
@benogle
Add Editor:onScrollTopChanged and Editor:onScrollLeftChanged
d4835e1
@benogle
Add Editor::onDidMoveCursor
601b311
@benogle
Add Editor::onDidChangeSelectedScreenRange
1d07317
@benogle
Make Editor::onDidChangeGrammar emit from Editor
5883e27 
Seems like the initial implementation was to handle the event, unfold 
all then, re-emit the grammar-changed event.
@benogle
Event docs
aebdfb4
@benogle
onDidMoveCursor -> onDidChangeCursorPosition
7198a91
@benogle
💄 doc strings
c7525e8
@benogle
Doc events in Cursor
9db804b
@benogle
onDidChangeSelectionScreenRange -> onDidChangeSelectionRange
858ac5b 
for consistency
@benogle
📝 Selection event methods
789d9c8
@benogle
isDestroyed -> destroyed
72be167
@benogle
use getPaneView rather than getPane
3e5666f
@benogle
Add and use Editor::observeSelections() and ::observeCursors()
0f83fe5
@benogle
Copy link
Contributor

benogle commented Sep 9, 2014

Provided tests pass, this is good to go.

benogle added a commit that referenced this pull request Sep 9, 2014
@benogle
Merge pull request #3456 from atom/ns-editor-event-methods
f357f69 
Add event subscription methods for Editor and associated classes
@benogle benogle merged commit f357f69 into master Sep 9, 2014
@benogle benogle deleted the ns-editor-event-methods branch September 9, 2014 20:41
@nathansobo
Copy link
Contributor Author

🚢

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees

@benogle benogle

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nathansobo @benogle @batjko @kevinsawicki