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

docs: Add remaining Keyman Engine for Android API's for KMManager #1294

Merged
merged 12 commits into from
Jul 2, 2024

Conversation

darcywong00
Copy link
Contributor

This adds remaining API pages to KMManager pointed out in an earlier review comment

`lexicalModelExists()`
: returns whether the specified lexical model exists in lexical models list

          Is this missing a separate page?

Originally posted by @mcdurdin in #1268 (comment)

@darcywong00 darcywong00 added this to the A18S3 milestone Jun 3, 2024
@mcdurdin mcdurdin modified the milestones: A18S3, A18S4 Jun 7, 2024
Copy link
Member

@mcdurdin mcdurdin left a 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!

Returns the KMKeyboard object.

## Description
The `getKMKeyboard()` method returns the KMKeyboard for the specified keyboard type.
Copy link
Member

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

Copy link
Contributor Author

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.
Copy link
Member

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>

@mcdurdin mcdurdin added the docs label Jun 18, 2024
Co-authored-by: Marc Durdin <marc@durdin.net>
@darcywong00 darcywong00 modified the milestones: A18S4, A18S5 Jun 21, 2024
@darcywong00
Copy link
Contributor Author

I think I've addressed all the comments so far. Ready to re-review

Copy link
Member

@mcdurdin mcdurdin left a 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. -->
Copy link
Member

Choose a reason for hiding this comment

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

TODO

Comment on lines +59 to +62
```java
// Send keystroke to KeymanWeb for processing: will return true to swallow the keystroke
return KMManager.executeHardwareKeystroke(code, keymanModifiers, keyboardType, Lstates, androidModifiers);
```
Copy link
Member

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.
Copy link
Member

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.
Copy link
Member

Choose a reason for hiding this comment

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

This is still TODO

@darcywong00 darcywong00 merged commit a0b0744 into master Jul 2, 2024
3 checks passed
@darcywong00 darcywong00 deleted the docs/android/kmmananager-18 branch July 2, 2024 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants