tbx  0.7.5
Public Member Functions | List of all members
tbx::CaretEvent Class Reference

Event data for lose or gain caret listener. More...

#include <caretlistener.h>

Inheritance diagram for tbx::CaretEvent:
tbx::EventInfo

Public Member Functions

 CaretEvent (IdBlock &id_block, PollBlock &poll_block)
 Construct from toolbox event information. More...
 
Window window () const
 Get Window that is losing (LoseCaretListener) or gaining (GainCaretListener) the caret. More...
 
Gadget gadget () const
 Get the gadget that is losing (LoseCaretListener) or gaining (GainCaretListener) the focus. More...
 
int x_offset () const
 Get the current x offset of the caret relative to the window origin.
 
int y_offset () const
 Get the current y offset of the caret relative to the window origin.
 
int height () const
 Get the height of the caret.
 
int colour () const
 Get caret colour - if colour set.
 
bool vdu () const
 Is it a vdu caret. More...
 
bool invisible () const
 Invisible caret.
 
bool uses_colour () const
 caret_color is used for the colour otherwise caret is Wimp colour 11
 
bool colour_untranslated () const
 Colour is untranslated, otherwise they are a Wimp colour.
 
int index () const
 The index of the caret into the writeable field or -1 if not in a writeable field.
 
- Public Member Functions inherited from tbx::EventInfo
 EventInfo (const IdBlock &id_block, PollBlock &data)
 Contruct the event information from the id_block and data update by the toolbox.
 
const IdBlockid_block () const
 IdBlock for the current event. More...
 

Additional Inherited Members

- Protected Attributes inherited from tbx::EventInfo
PollBlock_data
 raw data from the event
 

Detailed Description

Event data for lose or gain caret listener.

Constructor & Destructor Documentation

◆ CaretEvent()

tbx::CaretEvent::CaretEvent ( IdBlock id_block,
PollBlock poll_block 
)
inline

Construct from toolbox event information.

Parameters
id_blockObject/component data
poll_blockevent information

Member Function Documentation

◆ gadget()

Gadget tbx::CaretEvent::gadget ( ) const
inline

Get the gadget that is losing (LoseCaretListener) or gaining (GainCaretListener) the focus.

Returns
gadget or a null gadget it no gadget had the caret

◆ vdu()

bool tbx::CaretEvent::vdu ( ) const
inline

Is it a vdu caret.

Returns
true for vdu caret, false for antialiased caret

◆ window()

Window tbx::CaretEvent::window ( ) const
inline

Get Window that is losing (LoseCaretListener) or gaining (GainCaretListener) the caret.

Returns
window or a null window handle if no window has the caret

The documentation for this class was generated from the following file: