-
-
Notifications
You must be signed in to change notification settings - Fork 30
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
docs: Add remaining Keyman Engine for Android API's for KMManager #1294
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A fair few typos; so sorry for all the comments!
developer/engine/android/18.0/KMManager/executeHardwareKeystroke.md
Outdated
Show resolved
Hide resolved
developer/engine/android/18.0/KMManager/executeHardwareKeystroke.md
Outdated
Show resolved
Hide resolved
developer/engine/android/18.0/KMManager/executeHardwareKeystroke.md
Outdated
Show resolved
Hide resolved
Returns the KMKeyboard object. | ||
|
||
## Description | ||
The `getKMKeyboard()` method returns the KMKeyboard for the specified keyboard type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
KMKeyboard should link to the type
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added KMKeyboard page and link in 7f99859
: Non-negative position of the installed lexical model | ||
|
||
### Returns | ||
Returns a dictionary containing information on the specified lexical model. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The dictionary should be documented here (and the type Hashmap<String, String>
developer/engine/android/18.0/KMManager/setCanRemoveKeyboard.md
Outdated
Show resolved
Hide resolved
developer/engine/android/18.0/KMManager/setCanRemoveKeyboard.md
Outdated
Show resolved
Hide resolved
developer/engine/android/18.0/KMManager/setCanRemoveKeyboard.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Marc Durdin <marc@durdin.net>
I think I've addressed all the comments so far. Ready to re-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving but I think there are future TODOs. Ideally, the examples will include surrounding code to help clarify when and where a function may be called
|
||
The KMKeyboard is the core class which provides most of the methods you will need to develop an in-app or system keyboard with Keyman Engine | ||
|
||
<!-- Fill in examples of how to use, etc. --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO
```java | ||
// Send keystroke to KeymanWeb for processing: will return true to swallow the keystroke | ||
return KMManager.executeHardwareKeystroke(code, keymanModifiers, keyboardType, Lstates, androidModifiers); | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, should this be a TODO for future improvement then?
: `KeyboardType.KEYBOARD_TYPE_INAPP` or `KeyboardType.KEYBOARD_TYPE_SYSTEM` | ||
|
||
### Returns | ||
Returns the KMKeyboard object. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO for future improvement
Returns a list of all the installed lexical models. | ||
|
||
## Description | ||
Use this method to get details of all the installed lexical models. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is still TODO
This adds remaining API pages to KMManager pointed out in an earlier review comment
help.keyman.com/developer/engine/android/18.0/KMManager/index.md
Lines 179 to 180 in 73c9bc1
Originally posted by @mcdurdin in #1268 (comment)