Fl_Socket_Window Class Reference

Inheritance diagram for Fl_Socket_Window:

Public Member Functions
	Fl_Socket_Window (int X, int Y, int W, int H, const char *L=0)
virtual Window	plug_xid (void) const
virtual void	plug_xid (Window w)
Public Member Functions inherited from Fl_Window
virtual Fl_Window *	as_window ()
	Returns an Fl_Window pointer if this widget is an Fl_Window.
unsigned int	border () const
	See void Fl_Window::border(int)
void	border (int b)
	Sets whether or not the window manager border is around the window.
void	clear_border ()
	Fast inline function to turn the window manager border off.
void	copy_label (const char *a)
void	cursor (Fl_Cursor, Fl_Color=FL_BLACK, Fl_Color=FL_WHITE)
	Changes the cursor for this window.
int	decorated_h ()
	Returns the window height including any window title bar and any frame added by the window manager.
int	decorated_w ()
	Returns the window width including any frame added by the window manager.
void	default_cursor (Fl_Cursor, Fl_Color=FL_BLACK, Fl_Color=FL_WHITE)
	Sets the default window cursor as well as its color.
	Fl_Window (int w, int h, const char *title=0)
	Creates a window from the given size and title.
	Fl_Window (int x, int y, int w, int h, const char *title=0)
	Creates a window from the given position, size and title.
void	free_position ()
	Undoes the effect of a previous resize() or show() so that the next time show() is called the window manager is free to position the window.
void	fullscreen ()
	Makes the window completely fill the screen, without any window manager border visible.
void	fullscreen_off (int, int, int, int)
	Turns off any side effects of fullscreen() and does resize(x,y,w,h).
virtual int	handle (int)
	Handles the specified event.
virtual void	hide ()
	Removes the window from the screen.
void	hotspot (const Fl_Widget &p, int offscreen=0)
	See void Fl_Window::hotspot(int x, int y, int offscreen = 0)
void	hotspot (const Fl_Widget *, int offscreen=0)
	See void Fl_Window::hotspot(int x, int y, int offscreen = 0)
void	hotspot (int x, int y, int offscreen=0)
	Positions the window so that the mouse is pointing at the given position, or at the center of the given widget, which may be the window itself.
const void *	icon () const
	Gets the current icon window target dependent data.
void	icon (const void *ic)
	Sets the current icon window target dependent data.
void	iconize ()
	Iconifies the window.
const char *	iconlabel () const
	See void Fl_Window::iconlabel(const char*)
void	iconlabel (const char *)
	Sets the icon label.
const char *	label () const
	See void Fl_Window::label(const char*)
void	label (const char *)
	Sets the window title bar label.
void	label (const char *label, const char *iconlabel)
	Sets the icon label.
void	make_current ()
	Sets things up so that the drawing functions in <FL/fl_draw.H> will go into this window.
unsigned int	menu_window () const
	Returns true if this window is a menu window.
unsigned int	modal () const
	Returns true if this window is modal.
unsigned int	non_modal () const
	Returns true if this window is modal or non-modal.
unsigned int	override () const
	Returns non zero if FL_OVERRIDE flag is set, 0 otherwise.
virtual void	resize (int, int, int, int)
	Changes the size and position of the window.
void	set_menu_window ()
	Marks the window as a menu window.
void	set_modal ()
	A "modal" window, when shown(), will prevent any events from being delivered to other windows in the same program, and will also remain on top of the other windows (if the X window manager supports the "transient for" property).
void	set_non_modal ()
	A "non-modal" window (terminology borrowed from Microsoft Windows) acts like a modal() one in that it remains on top, but it has no effect on event delivery.
void	set_override ()
	Activates the flags NOBORDER|FL_OVERRIDE.
void	set_tooltip_window ()
	Marks the window as a tooltip window.
virtual void	show ()
	Puts the window on the screen.
void	show (int argc, char **argv)
	Puts the window on the screen and parses command-line arguments.
int	shown () const
	Returns non-zero if show() has been called (but not hide() ).
void	size_range (int a, int b, int c=0, int d=0, int e=0, int f=0, int g=0)
	Sets the allowable range the user can resize this window to.
unsigned int	tooltip_window () const
	Returns true if this window is a tooltip window.
int	x_root () const
	Gets the x position of the window on the screen.
const char *	xclass () const
	Returns the xclass for this window, or a default.
void	xclass (const char *c)
	Sets the xclass for this window.
int	y_root () const
	Gets the y position of the window on the screen.
virtual	~Fl_Window ()
	The destructor also deletes all the children.
Public Member Functions inherited from Fl_Group
Fl_Widget *&	_ddfdesign_kludge ()
	This is for forms compatibility only.
void	add (Fl_Widget &)
	The widget is removed from its current group (if any) and then added to the end of this group.
void	add (Fl_Widget *o)
	See void Fl_Group::add(Fl_Widget &w)
void	add_resizable (Fl_Widget &o)
	Adds a widget to the group and makes it the resizable widget.
Fl_Widget *const *	array () const
	Returns a pointer to the array of children.
virtual Fl_Group *	as_group ()
	Returns an Fl_Group pointer if this widget is an Fl_Group.
void	begin ()
	Sets the current group so you can build the widget tree by just constructing the widgets.
Fl_Widget *	child (int n) const
	Returns array()[n].
int	children () const
	Returns how many child widgets the group has.
void	clear ()
	Deletes all child widgets from memory recursively.
unsigned int	clip_children ()
	Returns the current clipping mode.
void	clip_children (int c)
	Controls whether the group widget clips the drawing of child widgets to its bounding box.
void	end ()
	Exactly the same as current(this->parent()).
int	find (const Fl_Widget &o) const
	See int Fl_Group::find(const Fl_Widget *w) const.
int	find (const Fl_Widget *) const
	Searches the child array for the widget and returns the index.
	Fl_Group (int, int, int, int, const char *=0)
	Creates a new Fl_Group widget using the given position, size, and label string.
void	focus (Fl_Widget *W)
void	forms_end ()
	This is for forms compatibility only.
void	init_sizes ()
	Resets the internal array of widget sizes and positions.
void	insert (Fl_Widget &, int i)
	The widget is removed from its current group (if any) and then inserted into this group.
void	insert (Fl_Widget &o, Fl_Widget *before)
	This does insert(w, find(before)).
void	remove (Fl_Widget &)
	Removes a widget from the group but does not delete it.
void	remove (Fl_Widget *o)
	Removes the widget o from the group.
void	remove (int index)
	Removes the widget at index from the group but does not delete it.
Fl_Widget *	resizable () const
	See void Fl_Group::resizable(Fl_Widget *box)
void	resizable (Fl_Widget &o)
	See void Fl_Group::resizable(Fl_Widget *box)
void	resizable (Fl_Widget *o)
	The resizable widget defines the resizing box for the group.
virtual	~Fl_Group ()
	The destructor also deletes all the children.
Public Member Functions inherited from Fl_Widget
void	activate ()
	Activates the widget.
unsigned int	active () const
	Returns whether the widget is active.
int	active_r () const
	Returns whether the widget and all of its parents are active.
Fl_Align	align () const
	Gets the label alignment.
void	align (Fl_Align alignment)
	Sets the label alignment.
long	argument () const
	Gets the current user data (long) argument that is passed to the callback function.
void	argument (long v)
	Sets the current user data (long) argument that is passed to the callback function.
virtual class Fl_Gl_Window *	as_gl_window ()
	Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window.
Fl_Boxtype	box () const
	Gets the box type of the widget.
void	box (Fl_Boxtype new_box)
	Sets the box type for the widget.
Fl_Callback_p	callback () const
	Gets the current callback function for the widget.
void	callback (Fl_Callback *cb)
	Sets the current callback function for the widget.
void	callback (Fl_Callback *cb, void *p)
	Sets the current callback function for the widget.
void	callback (Fl_Callback0 *cb)
	Sets the current callback function for the widget.
void	callback (Fl_Callback1 *cb, long p=0)
	Sets the current callback function for the widget.
unsigned int	changed () const
	Checks if the widget value changed since the last callback.
void	clear_changed ()
	Marks the value of the widget as unchanged.
void	clear_damage (fl_damage_t c=0)
	Clears or sets the damage flags.
void	clear_output ()
	Sets a widget to accept input.
void	clear_visible ()
	Hides the widget.
void	clear_visible_focus ()
	Disables keyboard focus navigation with this widget.
Fl_Color	color () const
	Gets the background color of the widget.
void	color (Fl_Color bg)
	Sets the background color of the widget.
void	color (Fl_Color bg, Fl_Color sel)
	Sets the background and selection color of the widget.
Fl_Color	color2 () const
	For back compatibility only.
void	color2 (unsigned a)
	For back compatibility only.
int	contains (const Fl_Widget *w) const
	Checks if w is a child of this widget.
void	copy_label (const char *new_label)
	Sets the current label.
void	copy_tooltip (const char *text)
	Sets the current tooltip text.
fl_damage_t	damage () const
	Returns non-zero if draw() needs to be called.
void	damage (fl_damage_t c)
	Sets the damage bits for the widget.
void	damage (fl_damage_t c, int x, int y, int w, int h)
	Sets the damage bits for an area inside the widget.
int	damage_resize (int, int, int, int)
	Internal use only.
void	deactivate ()
	Deactivates the widget.
Fl_Image *	deimage ()
	Gets the image that is used as part of the widget label.
const Fl_Image *	deimage () const
void	deimage (Fl_Image &img)
	Sets the image to use as part of the widget label.
void	deimage (Fl_Image *img)
	Sets the image to use as part of the widget label.
void	do_callback ()
	Calls the widget callback.
void	do_callback (Fl_Widget *o, long arg)
	Calls the widget callback.
void	do_callback (Fl_Widget *o, void *arg=0)
	Calls the widget callback.
void	draw_label (int, int, int, int, Fl_Align) const
	Draws the label in an arbitrary bounding box with an arbitrary alignment.
int	h () const
	Gets the widget height.
Fl_Image *	image ()
	Gets the image that is used as part of the widget label.
const Fl_Image *	image () const
void	image (Fl_Image &img)
	Sets the image to use as part of the widget label.
void	image (Fl_Image *img)
	Sets the image to use as part of the widget label.
int	inside (const Fl_Widget *w) const
	Checks if this widget is a child of w.
const char *	label () const
	Gets the current label text.
void	label (const char *text)
	Sets the current label pointer.
void	label (Fl_Labeltype a, const char *b)
	Shortcut to set the label text and type in one call.
Fl_Color	labelcolor () const
	Gets the label color.
void	labelcolor (Fl_Color c)
	Sets the label color.
Fl_Font	labelfont () const
	Gets the font to use.
void	labelfont (Fl_Font f)
	Sets the font to use.
Fl_Fontsize	labelsize () const
	Gets the font size in pixels.
void	labelsize (Fl_Fontsize pix)
	Sets the font size in pixels.
Fl_Labeltype	labeltype () const
	Gets the label type.
void	labeltype (Fl_Labeltype a)
	Sets the label type.
void	measure_label (int &ww, int &hh) const
	Sets width ww and height hh accordingly with the label size.
unsigned int	output () const
	Returns if a widget is used for output only.
Fl_Group *	parent () const
	Returns a pointer to the parent widget.
void	parent (Fl_Group *p)
	Internal use only - "for hacks only".
void	position (int X, int Y)
	Repositions the window or widget.
void	redraw ()
	Schedules the drawing of the widget.
void	redraw_label ()
	Schedules the drawing of the label.
Fl_Color	selection_color () const
	Gets the selection color.
void	selection_color (Fl_Color a)
	Sets the selection color.
void	set_changed ()
	Marks the value of the widget as changed.
void	set_output ()
	Sets a widget to output only.
void	set_visible ()
	Makes the widget visible.
void	set_visible_focus ()
	Enables keyboard focus navigation with this widget.
void	size (int W, int H)
	Changes the size of the widget.
int	take_focus ()
	Gives the widget the keyboard focus.
unsigned int	takesevents () const
	Returns if the widget is able to take events.
int	test_shortcut ()
	Returns true if the widget's label contains the entered '&x' shortcut.
const char *	tooltip () const
	Gets the current tooltip text.
void	tooltip (const char *text)
	Sets the current tooltip text.
uchar	type () const
	Gets the widget type.
void	type (uchar t)
	Sets the widget type.
void *	user_data () const
	Gets the user data for this widget.
void	user_data (void *v)
	Sets the user data for this widget.
unsigned int	visible () const
	Returns whether a widget is visible.
unsigned int	visible_focus ()
	Checks whether this widget has a visible focus.
void	visible_focus (int v)
	Modifies keyboard focus navigation.
int	visible_r () const
	Returns whether a widget and all its parents are visible.
int	w () const
	Gets the widget width.
Fl_When	when () const
	Returns the conditions under which the callback is called.
void	when (uchar i)
	Sets the flags used to decide when a callback is called.
Fl_Window *	window () const
	Returns a pointer to the primary Fl_Window widget.
int	x () const
	Gets the widget position in its window.
int	y () const
	Gets the widget position in its window.
virtual	~Fl_Widget ()
	Destroys the widget.

Static Public Member Functions
static bool	is_socket (Fl_Window *w)
Static Public Member Functions inherited from Fl_Window
static Fl_Window *	current ()
	Returns the last window that was made current.
static void	default_callback (Fl_Window *, void *v)
	Back compatibility: Sets the default callback v for win to call on close event.
static const char *	default_xclass ()
	Returns the default xclass.
static void	default_xclass (const char *)
	Sets the default window xclass.
Static Public Member Functions inherited from Fl_Group
static Fl_Group *	current ()
	Returns the currently active group.
static void	current (Fl_Group *g)
	Sets the current group.
Static Public Member Functions inherited from Fl_Widget
static void	default_callback (Fl_Widget *cb, void *d)
	Sets the default callback for all widgets.
static unsigned int	label_shortcut (const char *t)
	Returns the Unicode value of the '&x' shortcut in a given text.
static int	test_shortcut (const char *, const bool require_alt=false)
	Returns true if the given text t contains the entered '&x' shortcut.

Additional Inherited Members
Protected Types inherited from Fl_Widget
enum	{   INACTIVE = 1<<0 , INVISIBLE = 1<<1 , OUTPUT = 1<<2 , NOBORDER = 1<<3 ,   FORCE_POSITION = 1<<4 , NON_MODAL = 1<<5 , SHORTCUT_LABEL = 1<<6 , CHANGED = 1<<7 ,   OVERRIDE = 1<<8 , VISIBLE_FOCUS = 1<<9 , COPIED_LABEL = 1<<10 , CLIP_CHILDREN = 1<<11 ,   MENU_WINDOW = 1<<12 , TOOLTIP_WINDOW = 1<<13 , MODAL = 1<<14 , NO_OVERLAY = 1<<15 ,   GROUP_RELATIVE = 1<<16 , COPIED_TOOLTIP = 1<<17 , USERFLAG3 = 1<<29 , USERFLAG2 = 1<<30 ,   USERFLAG1 = 1<<31 }
	flags possible values enumeration. More...
Protected Member Functions inherited from Fl_Window
virtual void	draw ()
	Draws the widget.
virtual void	flush ()
	Forces the window to be drawn, this window is also made current and calls draw().
int	force_position () const
	Returns the internal state of the window's FORCE_POSITION flag.
void	force_position (int force)
	Sets an internal flag that tells FLTK and the window manager to honor position requests.
Protected Member Functions inherited from Fl_Group
void	draw_child (Fl_Widget &widget) const
	Forces a child to redraw.
void	draw_children ()
	Draws all children of the group.
void	draw_outside_label (const Fl_Widget &widget) const
	Parents normally call this to draw outside labels of child widgets.
int *	sizes ()
	Returns the internal array of widget sizes and positions.
void	update_child (Fl_Widget &widget) const
	Draws a child only if it needs it.
Protected Member Functions inherited from Fl_Widget
void	clear_flag (unsigned int c)
	Clears a flag in the flags mask.
void	draw_backdrop () const
	If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn.
void	draw_box () const
	Draws the widget box according its box style.
void	draw_box (Fl_Boxtype t, Fl_Color c) const
	Draws a box of type t, of color c at the widget's position and size.
void	draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const
	Draws a box of type t, of color c at the position X,Y and size W,H.
void	draw_focus ()
	draws a focus rectangle around the widget
void	draw_focus (Fl_Boxtype t, int x, int y, int w, int h) const
	Draws a focus box for the widget at the given position and size.
void	draw_label () const
	Draws the widget's label at the defined label position.
void	draw_label (int, int, int, int) const
	Draws the label in an arbitrary bounding box.
	Fl_Widget (int x, int y, int w, int h, const char *label=0L)
	Creates a widget at the given position and size.
unsigned int	flags () const
	Gets the widget flags mask.
void	h (int v)
	Internal use only.
void	set_flag (unsigned int c)
	Sets a flag in the flags mask.
void	w (int v)
	Internal use only.
void	x (int v)
	Internal use only.
void	y (int v)
	Internal use only.
Static Protected Attributes inherited from Fl_Window
static Fl_Window *	current_
	Stores the last window that was made current.

---

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

• Fl_Socket_Window.H