A frame that lays out in multiple rows or by columns, but only one control deep. More...

Inheritance diagram for Laxkit::RowFrame:

Public Member Functions
	RowFrame (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 owner, const char *mes, int npad=0)
	RowFrame constructor.
virtual int	init ()
	Default RowFrame init only calls Sync(1).
virtual int	Sync (int add=0)
	Sync the boxes to win_w/win_h, which are assumed set already.
virtual int	MoveResize (int nx, int ny, int nw, int nh)
	Calls anXWindow::MoveResize, then Sync(0).
virtual int	Resize (int nw, int nh)
	Calls anXWindow::Resize, then Sync(0).
virtual int	findWindowIndex (const char *name)
	Return the index in RowColBox::wholelist containing a window with name as the title.
virtual anXWindow *	findWindow (const char *name)
	Return the window in RowColBox::wholelist that has name as its win_name or win_title.
virtual int	AddNull (int where=-1)
	Call this to insert a line break into the window stack.
virtual int	AddHSpacer (int npw, int nws, int nwg, int nhalign, int where=-1)
virtual int	AddVSpacer (int npw, int nws, int nwg, int nhalign, int where=-1)
virtual int	AddSpacer (int npw, int nws, int nwg, int nhalign, int nph, int nhs, int nhg, int nvalign, int where=-1)
virtual int	AddWin (WinFrameBox *box, char islocal=1, int where=-1)
	Add an already made WinFrameBox.
virtual int	AddWin (anXWindow *win, int absorbcount, int where)
	Add a window using the window's width and height with no squishability.
virtual int	AddWin (anXWindow *win, int absorbcount, int npw, int nws, int nwg, int nhalign, int nhgap, int nph, int nhs, int nhg, int nvalign, int nvgap, int where)
	Add a window with squish values.
virtual void	Refresh ()
	Call Sync(0) if arrangedstate!=1.
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	close ()
	Called by anXApp from anXApp::destroywindow() when a window is to be destroyed.
virtual int	Idle (int tid=0)
	anXWindow::Idle() is an empty placeholeder. Just returns 1.
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	Event (const EventData data, const char mes)
	Default event handler.
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 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 Member Functions inherited from Laxkit::RowColBox
	RowColBox (unsigned int nflags, int nx, int nw, int npw, int nws, int nwg, int nhalign, int nhgap, int ny, int nh, int nph, int nhs, int nhg, int nvalign, int nvgap)
	Main RowColBox constructor.
virtual void	Push (SquishyBox *box, char islocal=0, int where=-1)
	Push box onto wholelist with islocal.
virtual int	Pop (int which=-1)
	Remove box with index which from wholelist.
virtual void	Flush ()
	Flush list, and if list does not exist, then create a new list.
virtual int	arrangeBoxes (int distributetoo=0)
	Set up SquishyBox::list to contain rows and columns based on boxes in wholelist.
virtual int	distributeBoxes (int setmetrics=0)
	Assign the x,y,w,h of the child boxes.
Public Member Functions inherited from Laxkit::ListBox
	ListBox (unsigned int flag=0)
	Create box as either BOX_VERTICAL or BOX_HORIZONTAL. Other flag values are ignored.
	ListBox (unsigned int nflags, int nx, int nw, int npw, int nws, int nwg, int nhalign, int nhgap, int ny, int nh, int nph, int nhs, int nhg, int nvalign, int nvgap)
virtual int	WrapToExtent ()
	Sets this->pw,s,g/ph,s,g to be the sum of the metrics of the boxes in list.
virtual void	sync ()
	Sync the box to the already set values of x,y,w,h.
virtual int	figureDimensions (ListBox target, int nextrow=NULL, SquishyBox *boxes=NULL, int n=0, double squishx=NULL, double *squishy=NULL)
	Finds pw,s,g/ph,s,g based on the boxes in list.
Public Member Functions inherited from Laxkit::SquishyBox
	SquishyBox (unsigned int nflags, int nx, int nw, int npw, int nws, int nwg, int nhalign, int nhgap, int ny, int nh, int nph, int nhs, int nhg, int nvalign, int nvgap)
	SquishyBox Constructor.
virtual int	hideBox (int yeshide)
	hideBox(0) makes the box visible, otherwise, make it hidden. Returns state after call.
virtual int	hidden ()
	Return whether the box is hidden or not.
virtual void	sync (int xx, int yy, int ww, int hh)
	Sync the box to x,y,w,h.
virtual int	x ()
virtual int	w ()
virtual int	pw ()
virtual int	ws ()
virtual int	wg ()
virtual int	halign ()
virtual int	hgap ()
virtual int	y ()
virtual int	h ()
virtual int	ph ()
virtual int	hs ()
virtual int	hg ()
virtual int	valign ()
virtual int	vgap ()
virtual int	x (int val)
virtual int	w (int val)
virtual int	pw (int val)
virtual int	ws (int val)
virtual int	wg (int val)
virtual int	halign (int val)
virtual int	hgap (int val)
virtual int	y (int val)
virtual int	h (int val)
virtual int	ph (int val)
virtual int	hs (int val)
virtual int	hg (int val)
virtual int	valign (int val)
virtual int	vgap (int val)
virtual int	fpenalty ()
virtual int	fpenalty (int val)
virtual int	lpenalty ()
virtual int	lpenalty (int val)

Public Attributes
unsigned long	highlight
unsigned long	shadow
unsigned long	mobkcolor
unsigned long	bkcolor
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
Public Attributes inherited from Laxkit::RowColBox
unsigned int	elementflags
Public Attributes inherited from Laxkit::ListBox
PtrStack< SquishyBox >	list
Public Attributes inherited from Laxkit::SquishyBox
int	m [14]
int	pad
	Pad placed around a box, which can be where a bevel or window border would go.
int	padinset
	Pad to inset the child boxes.
int	fpen
	The penalty in the flow direction.
int	lpen
	The penalty perpendicular to the flow direction.
unsigned long	flags

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 Member Functions inherited from Laxkit::RowColBox
virtual ListBox *	newSubBox ()
	Return a new box that holds a whole row or column.
virtual void	filterflags ()
	Take what is in flags, and remake flags to be reasonable for a RowColBox.
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
Protected Attributes inherited from Laxkit::RowColBox
PtrStack< SquishyBox >	wholelist
	The master list of boxes.
int	arrangedstate

Detailed Description

A frame that lays out in multiple rows or by columns, but only one control deep.

One can define separate RowFrame windows (or any other window that can be cast to SquishyBox), and Add(them) to achieve nesting.

Windows are added by rows (or columns) together with metric information including the preferred width, as well as the minimum and maximum width, plus the same for height. Adding a NULL window forces a row break. The min/max are never exceeded, thus for small windows, some of them will fall over the edges of the containing window. All this info is stored in a WinFrameBox.

If you want the window to wrap to the extent of the boxes, then call WrapToExtent() before init(), perhaps in preinit(), and before adding to a (parent) frame, so that you can use the computed extents for frame/init setup.

Todo:

make more clear all the layout options and padding, as well as implement them!!

***beware when deleting child windows, listbox stack becomes out of sync, it may have pointers to windows that have been delete'd already... maybe redefine deletekids to detect that?

  #define ROWFRAME_COLUMNS     (1<<16) <-- make columns full of boxes (but is a horizontal SquishyBox)
  #define ROWFRAME_VERTICAL    (1<<16) <-- make columns full of boxes (but is a horizontal SquishyBox)
  #define ROWFRAME_ROWS        (1<<17) <-- make rows full of boxes (but is a vertical SquishyBox)
  #define ROWFRAME_HORIZONTAL  (1<<17) <-- make rows full of boxes (but is a vertical SquishyBox)
  
  #define ROWFRAME_CENTER      (1<<19|1<<22)
  #define ROWFRAME_LEFT        (1<<18)
  #define ROWFRAME_HCENTER     (1<<19)
  #define ROWFRAME_RIGHT       (1<<20)
  #define ROWFRAME_TOP         (1<<21)
  #define ROWFRAME_VCENTER     (1<<22)
  #define ROWFRAME_BOTTOM      (1<<23)
  
   // these work with COLUMNS/ROWS/HORIZONTAL/VERTICAL to determine
   // flags&BOX_FLOW_MASK
  #define ROWFRAME_ROWS_TO_TOP    (0<<24)
  #define ROWFRAME_ROWS_TO_BOTTOM (1<<24)
  #define ROWFRAME_COLS_TO_LEFT   (0<<24)
  #define ROWFRAME_COLS_TO_RIGHT  (1<<24)
  #define ROWFRAME_ROWS_LR        (0<<25)
  #define ROWFRAME_ROWS_RL        (1<<25)
  #define ROWFRAME_COLS_TB        (0<<25)
  #define ROWFRAME_COLS_BT        (1<<25)
   // how to fill gaps between boxes
  #define ROWFRAME_STRETCH     (1<<27|1<<28)
  #define ROWFRAME_STRETCHX    (1<<27)
  #define ROWFRAME_STRETCHY    (1<<28)
  #define ROWFRAME_SPACE       (1<<29|1<<30)
  #define ROWFRAME_SPACEX      (1<<29)
  #define ROWFRAME_SPACEY      (1<<30)
  
   // these refer to filling extra (width in cols) or (height in rows)
  #define ROWFRAME_STRETCH_IN_ROW (1<<31)
  #define ROWFRAME_STRETCH_IN_COL (1<<31)

Constructor & Destructor Documentation

Laxkit::RowFrame::RowFrame	(	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	owner,
		const char *	mes,
		int	npad = `0`
	)

RowFrame constructor.

If the width or the height are 0, then it is implied that the window should size itself to wrap around the laid out windows, using a huge value (BOX_SHOULD_WRAP) for whichever size is 0 while RowFrame arranges everything. So for instance, you can specify a specific width, while height varies, which makes the whole thing laid out like a long page, and you'd only need a vertical scroller (not provided by RowFrame).

padi is the amount of space between child windows, and bevel is the size of a bevel that is put around each window.

Todo:: Deal with ROWFRAME_LAYOUT_MASK and LRTB, etc better...

Parameters:

npad	The amount of space to put along the borders of the RowFrame

References Laxkit::anXWindow::installColors(), Laxkit::SquishyBox::pad, and Laxkit::SquishyBox::padinset.

Member Function Documentation

int Laxkit::RowFrame::AddNull ( int where = -1 )

virtual

Call this to insert a line break into the window stack.

Return value is 0, and really means nothing.

References Laxkit::RowColBox::Push().

Referenced by AddWin(), Laxkit::ImageDialog::init(), LaxInterfaces::ViewerWindow::init(), Laxkit::FileDialog::init(), Laxkit::InputDialog::InputDialog(), Laxkit::MessageBox::MessageBox(), and Laxkit::SimplePrint::SimplePrint().

int Laxkit::RowFrame::AddWin	(	WinFrameBox *	box,
		char	islocal = `1`,
		int	where = `-1`
	)

virtual

Add an already made WinFrameBox.

This is really just a convenience function for any derived classes. It is not really necessary to create a whole box just in order to add a window.

The end result is for win to be pushed onto the top of wholelist.

References Laxkit::RowColBox::Push(), and Laxkit::anXApp::reparent().

Referenced by Laxkit::MessageBox::AddButton(), Laxkit::FileDialog::AddFinalButton(), Laxkit::PrintDialog::addOptions(), AddWin(), Laxkit::FileDialog::FileDialog(), Laxkit::ImageDialog::init(), LaxInterfaces::ViewerWindow::init(), Laxkit::FileDialog::init(), Laxkit::InputDialog::InputDialog(), Laxkit::MessageBox::MessageBox(), LaxInterfaces::ViewportWithStack::Refresh(), and Laxkit::SimplePrint::SimplePrint().

int Laxkit::RowFrame::AddWin	(	anXWindow *	win,
		int	absorbcount,
		int	where
	)

virtual

Add a window using the window's width and height with no squishability.

Reparents if win->win_parent!=this. If the window is derived from SquishyBox, then pass it on to SquishyBox::Push(win,0,where).

The end result is for win to be pushed onto position where of wholelist. where==-1 means to top.

Returns 0 on success, else nonzero

References AddNull(), AddWin(), Laxkit::RowColBox::Push(), and Laxkit::anXApp::reparent().

int Laxkit::RowFrame::AddWin	(	anXWindow *	win,
		int	absorbcount,
		int	npw,
		int	nws,
		int	nwg,
		int	nhalign,
		int	nhgap,
		int	nph,
		int	nhs,
		int	nhg,
		int	nvalign,
		int	nvgap,
		int	where
	)

virtual

Add a window with squish values.

Return 0 on success, else non zero error code.

The end result is for win to be pushed onto the top of wholelist.

Parameters:

win	The window to add
absorbcount	Whether to absorb one count of win
npw	New preferred width
nws	New horizontal shrink
nwg	New horizontal grow
nhalign	New horizontal align, 0=bottom/right, 100=top/left, 50=center, etc.
nhgap	New horizontal gap
nph	New preferred height
nhs	New vertical shrink
nhg	New vertical grow
nvalign	New vertical align, 0=bottom/right, 100=top/left, 50=center, etc.
nvgap	New vertical gap
where	Where in wholelist to add the window

References Laxkit::anObject::dec_count(), Laxkit::SquishyBox::pad, Laxkit::RowColBox::Push(), and Laxkit::anXApp::reparent().

int Laxkit::RowFrame::findWindowIndex ( const char * name )

virtual

Return the index in RowColBox::wholelist containing a window with name as the title.

The returned index can be used to position new windows with AddNull(), and AddWin().

References Laxkit::PtrStack< T >::e, Laxkit::PtrStack< T >::n, Laxkit::RowColBox::wholelist, Laxkit::anXWindow::win_name, and Laxkit::anXWindow::win_title.

Referenced by Laxkit::FileDialog::OkButton().

int Laxkit::RowFrame::init ( )

virtual

Default RowFrame init only calls Sync(1).

Normally, derived classes would redefine init to include their child windows, and it's just easier to call Sync(1) from there. RowFrame::init will always only just call Sync(1).

Reimplemented from Laxkit::anXWindow.

Reimplemented in Laxkit::FileDialog, Laxkit::ImageDialog, LaxInterfaces::ViewerWindow, and Laxkit::SimplePrint.

References Sync().

void Laxkit::RowFrame::Refresh ( )

virtual

Call Sync(0) if arrangedstate!=1.

*** draw box around the elements for debugging..

Reimplemented from Laxkit::anXWindow.

References Laxkit::PtrStack< T >::n, Sync(), and Laxkit::anXWindow::win_on.

int Laxkit::RowFrame::Sync ( int add = 0 )

virtual

Sync the boxes to win_w/win_h, which are assumed set already.

Calls sync(), which is SquishyBox::sync() which in turn calls arrangeBoxes(1) unless a derived class redefines sync(). Then, if (add) then app->addwindow on any window boxes that do not have window nonzero.

After a Sync, then arrangedstate will be 1.

References Laxkit::anXApp::addwindow(), Laxkit::PtrStack< T >::e, Laxkit::PtrStack< T >::n, Laxkit::ListBox::sync(), and Laxkit::RowColBox::wholelist.

Referenced by Laxkit::ImageDialog::init(), LaxInterfaces::ViewerWindow::init(), init(), Laxkit::FileDialog::init(), LaxInterfaces::ViewportWithStack::Refresh(), and Refresh().

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

rowframe.h
rowframe.cc

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation