The stump-touchy-mode-line Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The stump-touchy-mode-line Reference Manual

This is the stump-touchy-mode-line Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:23:31 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

stump-touchy-mode-line

Why it should be hard to use STUMPWM on tablets?

This package makes it easy to define "buttons" in the mode-line: when certain area on a mode line is clicked, certain function gets called.

Of course, main power of this lies in what functions you exactly bind to mode-line buttons. Relevant snippet of my .stumpwmrc looks like

(ql:quickload 'stump-touchy-mode-line)

(setf *space-between-buttons* 0.25) ; there should be one quarter of button's length between buttons
(setf *min-button-length* 20) ; and minimum button length should be 20 pixels
(set-touchy-mode-line pull-hidden-next ; circle through windows in a group
		      bring-lx-terminal ; bring lxterminal to front, create one, if it does not exist
		      circle-through-splits ; circles through layouts I commonly use
                                            ; one frame, two vertical frames, two horizontal frames
		      fnext ; circle through frames on a screen
		      nil ; empty space
		      nil ; empty space
		      toggle-virt-keyboard-mode ; force two horizontal frames, bring cellwriter (virtual keyboard)
                                                ; to the lower frame
		      gnext ; circle through groups
                      )

Essentially, functions BRING-LX-TERMINAL and TOGGLE-VIRT-KEYBOARD-MODE already allow further customizations using only touchscreen, everything else is just a convenience.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 stump-touchy-mode-line

Author

Alexandr Popolitov <popolit@gmail.com>

License

GPL

Description

Easily make areas of modeline behave like buttons

Dependencies
Source

stump-touchy-mode-line.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 stump-touchy-mode-line.asd

Location

stump-touchy-mode-line.asd

Systems

stump-touchy-mode-line (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 stump-touchy-mode-line/package.lisp

Parent

stump-touchy-mode-line (system)

Location

package.lisp

Packages

stump-touchy-mode-line


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 stump-touchy-mode-line/stump-touchy-mode-line.lisp

Dependency

package.lisp (file)

Parent

stump-touchy-mode-line (system)

Location

stump-touchy-mode-line.lisp

Exported Definitions
Internal Definitions

button-boundaries (function)


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 stump-touchy-mode-line

Source

package.lisp (file)

Use List
Used By List

stumpwm

Exported Definitions
Internal Definitions

button-boundaries (function)


Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *min-button-length*

Minimum length of a button, in pixels

Package

stump-touchy-mode-line

Source

stump-touchy-mode-line.lisp (file)

Special Variable: *space-between-buttons*

Inactive space between buttons, in lengths of a button

Package

stump-touchy-mode-line

Source

stump-touchy-mode-line.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: set-touchy-mode-line &rest SPECS
Package

stump-touchy-mode-line

Source

stump-touchy-mode-line.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: button-boundaries BUTTON-LENGTH NUMBER
Package

stump-touchy-mode-line

Source

stump-touchy-mode-line.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, stump-touchy-mode-line.asd: The stump-touchy-mode-line<dot>asd file
File, Lisp, stump-touchy-mode-line/package.lisp: The stump-touchy-mode-line/package<dot>lisp file
File, Lisp, stump-touchy-mode-line/stump-touchy-mode-line.lisp: The stump-touchy-mode-line/stump-touchy-mode-line<dot>lisp file

L
Lisp File, stump-touchy-mode-line.asd: The stump-touchy-mode-line<dot>asd file
Lisp File, stump-touchy-mode-line/package.lisp: The stump-touchy-mode-line/package<dot>lisp file
Lisp File, stump-touchy-mode-line/stump-touchy-mode-line.lisp: The stump-touchy-mode-line/stump-touchy-mode-line<dot>lisp file

S
stump-touchy-mode-line.asd: The stump-touchy-mode-line<dot>asd file
stump-touchy-mode-line/package.lisp: The stump-touchy-mode-line/package<dot>lisp file
stump-touchy-mode-line/stump-touchy-mode-line.lisp: The stump-touchy-mode-line/stump-touchy-mode-line<dot>lisp file

Jump to:   F   L   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   B   F   M   S  
Index Entry  Section

B
button-boundaries: Internal functions

F
Function, button-boundaries: Internal functions

M
Macro, set-touchy-mode-line: Exported macros

S
set-touchy-mode-line: Exported macros

Jump to:   B   F   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*min-button-length*: Exported special variables
*space-between-buttons*: Exported special variables

S
Special Variable, *min-button-length*: Exported special variables
Special Variable, *space-between-buttons*: Exported special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, stump-touchy-mode-line: The stump-touchy-mode-line package

S
stump-touchy-mode-line: The stump-touchy-mode-line system
stump-touchy-mode-line: The stump-touchy-mode-line package
System, stump-touchy-mode-line: The stump-touchy-mode-line system

Jump to:   P   S