This class defines popup balloon help for Locana. You can disable all balloon help by calling Lballoon_help.disable(). You can set the amount of time to wait for balloon help by calling Lballoon_help.time=(millisec). This class is based on the Llabel class and includes the Lwindow_popup module so this looks and acts like a popup window.

This is a menu item that you can add to your menus to consistently allow the user to enable/disable balloon help.

• menu - the Lmenu object you want to add the balloon help toggle to.

This adds a menu item to menu and add the :on_click event for the new menu item. For example:

     menu(:mHelp, :text=>'&Help') {     # the menu you want to add the balloon help toggle to
        menu(:mAbout, :text=>'&About')  # any other menu items you want to add
        Lballoon_help.menu_item(self)  # adds menu(:mBalloonHelp, :text=>'&Balloon Help is ' + (Lballoon_help.enabled ? 'on' : 'off'))
     }

Enables all balloon help. This is automatically saved to the Locana config file and reloaded the next time you run your applet.

Disables all balloon help. This is automatically saved to the Locana config file and reloaded the next time you run.

Returns true if balloon help is disabled. Returns false or nil if balloon help is enabled.

Returns true if balloon help is enabled. Returns false if balloon help is disabled.

Allows you to set the amount of time in millisecs for the popup help to appear. The default is 1 second.

Sets the amount of time in millisecs for the pop-help to appear. The :on_mouse_over event triggers the balloon help timer.

Returns true if the balloon help timer is active.

Start the balloon timer for object. When the timer expires, the popup balloon help appears.

Cancels the balloon help timer.

Opens balloon help for object. The :on_mouse_over event triggers the balloon help timer.

• object - any a locana object, typically the mouse will be hovering over this object.

Close the balloon help if it’s open.

Returns the symbol to use as the default border for this object. The default is :none.

The default background color is :lightyellow.

Lets add a little padding so the popup help looks a little better. The default is 6.

Lets add a little padding so the popup help looks a little better. The default is 3.

Creates an instance variable to remember the object associated with the balloon help.

Returns a new string containing the word wrapped and formatted help_text for displaying in the popup balloon help. If help_text has line feeds imbedded within it, it will be returned without any formatting applied. Line feeds implies the text has already been pre-formatted for display.

• help_text - a string to format, typically this is the :help attribute of the Locana object under the mouse

This opens the balloon help. The :on_mouse_over event triggers the balloon help timer which triggers the opening the balloon help.