PenMenu

The supported pen set on Pen Menu: All. It will enable all pens that can be used in HtcPaintingView

The supported pen set on Pen Menu: Only simple pen (the default stroke type supported by Android) and eraser pen are supported.

Constants for IPaintingView stroke visibility. The ID of stroke visibility: STROKE_INVISIBLE. Set stroke to lower opacity value.

Constants for IPaintingView stroke visibility. The ID of stroke visibility: STROKE_VISIBLE. Set stroke to original opacity value.

Called to switch the show/hide state of the PenMenu alternately.

Force to hide the strokes (lower the opacity to the predefined value) on painting view when the value of forceHide is set to true or restore the original state of strokes when the value of forceHide is set to false. This function is provided for integrated APPs when users want to interact with the contents behind the painting view. For example, users may press the lower hardware button of Pen to enable Text Selection function. The integrated APPs can call this function to hide on-screen strokes. It will provide a clear view to let users do Text Selection.

Receive the key event passed by applications. If the Hardware Pen Button is pressed, PenMenu will then switch the show/hide state alternately.

Hide PenMenu. Client app can control whether to play animation by playAnimation parameter. And the turnOffStickyState parameter can control whether the sticky state should be forced to turn off. The sticky state is for controlling the behavior to restore PenMenu's previous show/hide state when it is hidden. If this flag is turned off, the PenMenu couldn't show itself.

Called to let PenMenu do the cleanup, including the registered receiver and allocated resources

Callback for invoke on Activity#onOptionsMenuClosed or whatever hide the PenMenu by previous onMenuOpened() call. Client app should always call this method on its Activity#onOptionsMenuClosed. Note. The method should be called in pair with onMenuOpened()

Callback for invoke on Activity#onMenuOpened or whatever would overlay with PenMenu to hide the PenMenu. Client app should always call this method on its Activity#onMenuOpened. Note. The method should be called in pair with onMenuClosed()

Called to let PenMenu retrieve the previous saved state and settings. PenMenu will restore its state and settings after device orientation is changed.

Called to let PenMenu have chance to save current show/hide state and settings before being killed so that the state and settings can be restored later. PenMenu will keep its state and setting while device orientation is changed.

Restore current pen settings and history pens settings if any. This function is designed for the feature of global pens settings (share the same preferences between all pen integrated APPs). When the setting, using the same pen settings among all pen integrated APPs, is set to true. The integrated APPs is responsible to call this function before activities are back to foreground. Once this is called, PenMune module will then restore pen settings by using the global preferences. If the setting is set to false, called this function will restore pen settings by using the local preferences. The pen integrated activities should call this method at their Activity#onResume() method.

Save current pen settings and history pens settings if any. This function is designed for the feature of global pens settings (share the same preferences between all pen integrated APPs). When the setting, using the same pen settings among all pen integrated APPs, is set to true. The integrated APPs is responsible to call this function before activities switch to background. Once this is called, PenMune module will then save current pen preferences for the next foreground pen-integrated activity. If the setting is set to false, called this function will save pen settings in the local preference. The pen integrated activities should call this method at their Activity#onPause() method.

When the applications implement their own painting view and integrate with Pen Menu with different behaviors, they can disable action buttons by calling this function. For example, when the customized painting view doesn't support Clear All function, call this function to grey out Clear All button. Simply, pass the identification of action button and its new state.

Called to enable/disable the Eraser mode. When pressing the upper buttons on the H/W Pen and the its corresponding function is configured to Eraser, applications can call this function to enable Eraser mode and the size of Eraser mode will be the same as the current size of Eraser Pen. Once the button is released, call this function with false parameter to disable Eraser mode and restore pen to previous setting.

Used for registering one listener to Pen Menu. Once registered, when the action buttons on Pen Menu are tapped by pen, the application will receive notification. The current action buttons are listed below.

• PenMenu#CLEAR_ACTION_ID
• PenMenu#VISIBLE_ACTION_ID
• PenMenu#UNDO_ACTION_ID
• PenMenu#REDO_ACTION_ID

Associate HtcPaintingView with PenMenu. Once the association is created, any user actions made on PenMenu will apply to Painting Engine, including Pen settings (stroke, size and color) and actions (redo, undo, clear all and set ink opacity)

When applications implement their own painting view and integrate with HTC Pen Menu with limited pen set, call this function to grey out the predefined pens enabled on the device. Currently, only following pen set are supported for Pen Menu.

• PENSET_ALL
• PENSET_SIMPLE
• PenMenu#PENSET_SINGLE

Show PenMenu. Client app can control whether to play animation by playAnimation parameter. And the turnOnStickyState parameter can control whether the sticky state should be forced to turn on. The sticky state is for controlling the behavior to restore PenMenu's previous state when it is hidden. If this flag is turned off, the method has no effect.