The ToolTip class is used within anXApp. More...
Inheritance diagram for Laxkit::ToolTip:
Public Member Functions | |
| ToolTip (const char *newtext, int mouse) | |
| virtual int | Idle (int tid=0) |
| Destroy itself if time up. | |
| virtual void | Refresh () |
| Just dump out the text, left justified. | |
| virtual int | Event (const EventData *d, const char *mes) |
| The tooltip destroys itself when any key or mouse events occur. | |
 Public Member Functions inherited from Laxkit::anXWindow | |
| anXWindow (anXWindow *parnt, const char *nname, const char *ntitle, unsigned long nstyle, int xx, int yy, int ww, int hh, int brder, anXWindow *prev, unsigned long nowner, const char *nsend) | |
| Constructor. | |
| virtual | ~anXWindow () |
| anXWindow destructor. Its X window should have been XDestroy'd before here. | |
| virtual const char * | whattype () |
| virtual const char * | WindowTitle (int which=0) |
| Return basically the name of the window. | |
| virtual void | WindowTitle (const char *newtitle) |
| Change the title of the window. This text would usually be displayed in the bar provided by a window manager. | |
| virtual const char * | tooltip (int mouseid=0) |
| By default, return win_tooltip. | |
| virtual const char * | tooltip (const char *newtooltip) |
| Replace the current tooltip, return the current tooltip (after replacing). | |
| virtual anXWindow * | findChildWindowByTitle (const char *title) |
| Find the first immediate child window that has win_title==title. | |
| virtual anXWindow * | findChildWindowByName (const char *name) |
| Find the first immediate child window that has win_name==name. | |
| virtual int | Grayed () |
| Return whether this window is grayed. | |
| virtual int | Grayed (int g) |
| Set the gray state of this window. Returns Grayed(void). | |
| virtual int | preinit () |
| virtual int | init () |
| Empty placeholeder. Just returns 0. | |
| virtual int | close () |
| Called by anXApp from anXApp::destroywindow() when a window is to be destroyed. | |
| virtual Displayer * | MakeCurrent () |
| virtual int | Needtodraw () |
| Default is to return needtodraw. | |
| virtual void | Needtodraw (int nntd) |
| If 0, then the window does not need refreshing. Otherwise it does. | |
| virtual int | deletenow () |
| Return whether the window is allowed to be deleted. | |
| virtual int | setWinStyle (unsigned int stylebit, int newvalue) |
| Control various window related basic styling of win_style. | |
| virtual int | getWinStyle (unsigned int stylebit) |
| Currently, simply return win_style&stylebit. | |
| virtual void | installColors (WindowColors *newcolors) |
| Dec_count old and inc_count new. | |
| virtual ShortcutHandler * | GetShortcuts () |
| Return a ShortcutHandler that contains stacks of bound shortcuts and possible window actions. | |
| virtual int | PerformAction (int action_number) |
| virtual int | ExposeChange (ScreenEventData *e) |
| Default behavior on Expose events is to call Needtodraw(1). | |
| virtual int | DeviceChange (const DeviceEventData *e) |
| virtual int | CharInput (unsigned int ch, const char *buffer, int len, unsigned int state, const LaxKeyboard *kb) |
| Input of character data or control character presses. | |
| virtual int | KeyUp (unsigned int ch, unsigned int state, const LaxKeyboard *kb) |
| Called when a key is released. | |
| virtual int | MouseMove (int x, int y, unsigned int state, const LaxMouse *m) |
| Empty placeholder, just returns 1. | |
| virtual int | ButtonDown (int button, int x, int y, unsigned int state, int count, const LaxMouse *m) |
| virtual int | ButtonUp (int button, int x, int y, unsigned int state, const LaxMouse *m) |
| virtual int | LBDown (int x, int y, unsigned int state, int count, const LaxMouse *d) |
| Default is just to return 1. | |
| virtual int | LBUp (int x, int y, unsigned int state, const LaxMouse *d) |
| Default is just to return 1. | |
| virtual int | MBDown (int x, int y, unsigned int state, int count, const LaxMouse *d) |
| Default is just to return 1. | |
| virtual int | MBUp (int x, int y, unsigned int state, const LaxMouse *d) |
| Default is just to return 1. | |
| virtual int | RBDown (int x, int y, unsigned int state, int count, const LaxMouse *d) |
| Default is just to return 1. | |
| virtual int | RBUp (int x, int y, unsigned int state, const LaxMouse *d) |
| Default is just to return 1. | |
| virtual int | WheelUp (int x, int y, unsigned int state, int count, const LaxMouse *d) |
| The wheel mouse rolling up. Default is just to return 1. | |
| virtual int | WheelDown (int x, int y, unsigned int state, int count, const LaxMouse *d) |
| The wheel mouse rolling down. Default is just to return 1. | |
| virtual int | FocusOn (const FocusChangeData *e) |
| Increment win_active, and highlights the window's border, if the event refers to this window. | |
| virtual int | FocusOff (const FocusChangeData *e) |
| Decrements win_active, and de-highlights the window's border if win_active==0, if event is a real focus off. | |
| virtual int | MoveResize (int nx, int ny, int nw, int nh) |
| Move and resize the window. | |
| virtual int | Resize (int nw, int nh) |
| Resize with new nw, and nh. | |
| virtual void | contentChanged () |
| Windows may call this when their contents change. | |
| virtual void | selectionChanged () |
| Windows may call this when their selections change. | |
| virtual anXWindow * | GetController () |
| Return the window most relevant for tab control loops. | |
| virtual int | SelectNextControl (const LaxDevice *d) |
| Transfer focus to nextcontrol. | |
| virtual int | SelectPrevControl (const LaxDevice *d) |
| Transfer the focus to prevcontrol. | |
| virtual void | ControlActivation (int on) |
| Do special activation or not when controls are activated by tabbing. | |
| virtual int | AddPrevControl (anXWindow *prev) |
| virtual int | AddNextControl (anXWindow *next) |
| virtual int | ConnectControl (anXWindow *towhat, int after=1) |
| Connect towhat to this. Used for tab loops. | |
| virtual int | CloseControlLoop () |
| Close a tab loop. | |
| virtual void | SetOwner (anXWindow *nowner, const char *mes=NULL, unsigned int send_mask=0) |
| Set the new owner and control message. | |
| virtual void | SetOwner (unsigned long nowner_id, const char *mes=NULL, unsigned int send_mask=0) |
| virtual void | dump_out (FILE *f, int indent, int what, anObject *context) |
| Simple dumping function. | |
| virtual LaxFiles::Attribute * | dump_out_atts (LaxFiles::Attribute *att, int what, anObject *context) |
| virtual void | dump_in_atts (LaxFiles::Attribute *att, int flag, anObject *context) |
| Public Member Functions inherited from Laxkit::Tagged | |
| virtual int | HasTag (const char *tag, int casematters) |
| Return whether the tag exists. | |
| virtual int | NumberOfTags () |
| Return the number of tags, strangely enough. | |
| virtual const char * | GetTag (int i) |
| Return const pointer to the tag text for tag number i, where i==0 is the first tag. | |
| virtual char * | GetAllTags () |
| Return a new char[] with a space separated list of all the tags. | |
| virtual int | InsertTags (const char *tags, int casematters) |
| Insert tags from a string such as 'tag1 tag2 tag3 "tag with spaces" tag4'. | |
| virtual int | InsertTag (const char *tag, int casematters) |
| Insert tag if it doesn't exist already. | |
| virtual int | RemoveTag (const char *tag) |
| The tag must be an exact match. | |
| virtual int | RemoveTag (int i) |
| Remove tag number i. i must be in range [0..NumberOfTags()-1]. | |
| virtual void | FlushTags () |
| Public Member Functions inherited from LaxFiles::DumpUtility | |
| virtual void | dump_in (FILE *f, int indent, int what, Laxkit::anObject *loadcontext, Attribute **att) |
| Read in a file segment as an Attribute, and pass parsing duties to dump_in_atts. | |
| virtual | ~DumpUtility () |
| Empty virtual destructor. | |
| Public Member Functions inherited from Laxkit::aDrawable | |
| aDrawable (Drawable d=0) | |
| virtual int | DrawableType () |
| virtual int | ValidDrawable () |
Public Attributes | |
| int | mouse_id |
| char * | thetext |
| int | textheight |
| int | fasc |
| Public Attributes inherited from Laxkit::anXWindow | |
| WindowColors * | win_colors |
| anXApp * | app |
| char * | win_name |
| An arbitrary string to be used as an id. | |
| char * | win_title |
| The title of the window. | |
| anXWindow * | win_parent |
| int | win_screen |
| unsigned long | win_style |
| int | win_x |
| int | win_y |
| int | win_w |
| int | win_h |
| unsigned int | win_border |
| int | win_pointer_shape |
| Identifier for a stock mouse shape. | |
| char | win_on |
| Nonzero if the window is mapped. | |
| char | win_active |
| Should be positive when the window has a keyboard focus, 0 otherwise. | |
| unsigned long | win_owner |
| Who gets control messages from this window. | |
| unsigned int | win_owner_send_mask |
| char * | win_sendthis |
| The type of message that gets sent to owner. | |
| anXWindow * | nextcontrol |
| anXWindow * | prevcontrol |
| Public Attributes inherited from Laxkit::Tagged | |
| int | sorttags |
Additional Inherited Members | |
| Protected Member Functions inherited from Laxkit::anXWindow | |
| virtual int | deletekid (anXWindow *w) |
| Purges child anXWindows from window's child stack. | |
| virtual void | SwapBuffers () |
| Swap buffers. This should be called from Refresh() if VIEWPORT_BACK_BUFFER is set in win_style. | |
| virtual void | SetupBackBuffer () |
| Initialize the backbuffer. | |
| Protected Attributes inherited from Laxkit::anXWindow | |
| char * | win_tooltip |
| Convenience variable to hold the window's tooltip, if any. | |
| int | needtodraw |
| RefPtrStack< anXWindow > | _kids |
| Stack of children of the window. | |
| Protected Attributes inherited from Laxkit::Tagged | |
| PtrStack< char > | list_of_tags |
Detailed Description
The ToolTip class is used within anXApp.
There can be one tooltip per mouse.
To give a window a tooltip, simply call win->tooltip("blah new tip"). Make sure that anXApp::tooltips is set to an adequate number of milliseconds, and anXApp will hover the tooltip near the current mouse position until the mouse moves again.
Multiline tooltips are simply one char array with the standard '\n' characters to delimit the lines.
- Todo:
- This class is basically a MessageBar without the input handling, maybe use that one instead for automatic text wrapping?
Constructor & Destructor Documentation
Constructor, initiates a timer that lasts for a maximum of 5 seconds + 1sec per every 20 characters.
References Laxkit::anXApp::addtimer(), Laxkit::getextent(), and Laxkit::mouseposition().
Member Function Documentation
Destroy itself if time up.
Also, the tooltip destroys itself by checking for any key or mouse event in the X event queue, for any window.
Reimplemented from Laxkit::anXWindow.
References Laxkit::anXApp::destroywindow().
The documentation for this class was generated from the following files:
- tooltip.h
- tooltip.cc