User Tools

Site Tools


windowctl

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

windowctl [2008/04/11 23:12]
windowctl [2008/04/11 23:12] (current)
Line 1: Line 1:
 +# $EPIC: windowctl.txt,​v 1.11 2008/04/11 23:12:17 jnelson Exp $
 +======Synopsis:​======
 +$__windowctl__(REFNUM <​refnum>​) \\
 +$__windowctl__(REFNUMS) \\
 +$__windowctl__(NEW)
 +
 +======Technical:​======
 +   * $windowctl(REFNUM <​window-name-or-refnum>​) \\ Given a window name or refnum, return the window'​s refnum.
 +   * $windowctl(REFNUMS) \\ Return all window refnums.
 +   * $windowctl(GET <​refnum>​ REFNUM) \\ Returns the window'​s refnum.
 +   * $windowctl(GET <​refnum>​ NAME) \\ Returns the window'​s name (or empty string if it doesn'​t have one)
 +   * $windowctl(GET <​refnum>​ SERVER) \\ Returns the server the window is connected to (or -1 if disconnected)
 +   * $windowctl(GET <​refnum>​ LAST_SERVER) \\ Returns the last server the window was connected to when disconnected. Returns -2 ("​NOSERV"​) in EPIC5.
 +   * $windowctl(GET <​refnum>​ PRIORITY) \\ Returns the window'​s current-window priority, used to track the previous current window(s).
 +   * $windowctl(GET <​refnum>​ VISIBLE) \\ Returns 1 if the window is on a screen, 0 if it is hidden.
 +   * $windowctl(GET <​refnum>​ TOP) \\ Where the window starts on the screen
 +   * $windowctl(GET <​refnum>​ BOTTOM) \\ Where the window ends on the screen
 +   * $windowctl(GET <​refnum>​ CURSOR) \\ Whether the cursor is sitting in this window
 +   * $windowctl(GET <​refnum>​ NOSCROLLCURSOR) \\ Always returns -1 (not implemented)
 +   * $windowctl(GET <​refnum>​ FIXED) \\ 1 if /[[WINDOW FIXED]] ON, 0 if /[[WINDOW FIXED]] OFF.
 +   * $windowctl(GET <​refnum>​ SCROLL) \\ 1 if /[[WINDOW SCROLL]] ON (which it always is)
 +   * $windowctl(GET <​refnum>​ CHANGE_LINE) \\ The next <​line>​ to be changed from /xecho -line <​line>​
 +   * $windowctl(GET <​refnum>​ OLD_SIZE) \\ The size of the window just after the last screen resize.
 +   * $windowctl(GET <​refnum>​ UPDATE) \\ 0 if the window is up to date, 1 if it needs to be refreshed.
 +   * $windowctl(GET <​refnum>​ MISCFLAGS) \\ Oh, don't ask me this...
 +   * $windowctl(GET <​refnum>​ NOTIFY) \\ 0 if /[[WINDOW NOTIFY]] OFF, 1 if /[[WINDOW NOTIFY]] ON
 +   * $windowctl(GET <​refnum>​ NOTIFY_NAME) \\ What will show up in %{1}F when the window is notified.
 +   * $windowctl(GET <​refnum>​ NOTIFIED) \\ 0 if the window hasn't had notified output since last hidden, 1 if it has.
 +   * $windowctl(GET <​refnum>​ BEEP_ALWAYS) \\ 0 if /[[WINDOW BEEP_ALWAYS]] OFF, 1 if /WINDOW BEEP_ALWAYS ON
 +   * $windowctl(GET <​refnum>​ NOTIFY_LEVEL) \\ The levels of output that causes notified output.
 +   * $windowctl(GET <​refnum>​ WINDOW_LEVEL) \\ The levels for new output that this window claims as its own.
 +   * $windowctl(GET <​refnum>​ SKIP) \\ 0 if /[[WINDOW SKIP]] OFF, 1 if /[[WINDOW SKIP]] ON
 +   * $windowctl(GET <​refnum>​ COLUMNS) \\ The number of columns in the window. ​ Someday you can change this!
 +   * $windowctl(GET <​refnum>​ PROMPT) \\ The current per-window prompt (from /[[exec command|exec]])
 +   * $windowctl(GET <​refnum>​ DOUBLE) \\ 0 if /[[WINDOW DOUBLE]] OFF, 1 if /[[WINDOW DOUBLE]] ON
 +   * $windowctl(GET <​refnum>​ STATUS_FORMAT) \\ The window'​s personal single-line status format (if any)
 +   * $windowctl(GET <​refnum>​ STATUS_FORMAT1) \\ The window'​s personal first double-line status format (if any)
 +   * $windowctl(GET <​refnum>​ STATUS_FORMAT2) \\ The window'​s personal second double-line status format (if any)
 +   * $windowctl(GET <​refnum>​ STATUS_LINE) \\ What the single-line status bar actually has in it
 +   * $windowctl(GET <​refnum>​ STATUS_LINE1) \\ What the first double-line status bar actually has in it
 +   * $windowctl(GET <​refnum>​ STATUS_LINE2) \\ What the second double-line status bar actually has in it
 +   * $windowctl(GET <​refnum>​ DISPLAY_BUFFER_SIZE) \\ How many lines are actually in the window'​s scrollback buffer
 +   * $windowctl(GET <​refnum>​ DISPLAY_BUFFER_MAX) \\ How many lines the scrollback buffer will hold before rolling off.
 +   * $windowctl(GET <​refnum>​ SCROLLING_DISTANCE) \\ How many lines the top of the scrolling view is from the bottom of the scrollback buffer.
 +   * $windowctl(GET <​refnum>​ HOLDING_DISTANCE) \\ How many lines the top of the hold mode view is from the bottom of the scrollback buffer. ​  1 we're not in hold mode
 +   * $windowctl(GET <​refnum>​ SCROLLBACK_DISTANCE) \\ How many lines the top of the scrollback view is from the bottom of the scrollback buffer. ​  1 if we're not in scrollback mode
 +   * $windowctl(GET <​refnum>​ DISPLAY_COUNTER) \\ Every line of output to a window gets a unique refnum. ​ This will be the unique refnum of the next line of output.
 +   * $windowctl(GET <​refnum>​ HOLD_SLIDER) \\ How much the window gets unheld if you hit <​enter>​
 +   * $windowctl(GET <​refnum>​ HOLD_INTERVAL) \\ How many new lines must be held each time %H gets updated on status bar.
 +   * $windowctl(GET <​refnum>​ LAST_LINES_HELD) \\ The current value of %H
 +   * $windowctl(GET <​refnum>​ WAITING_CHANNEL) \\ The last channel we sent a /[[JOIN]] for to attach to this window
 +   * $windowctl(GET <​refnum>​ BIND_CHANNEL) \\ The last channel we did a /[[WINDOW BIND]] for (removed in EPIC5)
 +   * $windowctl(GET <​refnum>​ CHANNELS) \\ A list of all of the channels you are on in the window. ​ There order of the channels is not defined.
 +   * $windowctl(GET <​refnum>​ QUERY_NICK) \\ The current /query in this window ​
 +   * $windowctl(GET <​refnum>​ NICKLIST) \\ The contents of the auxilliary query list (/[[window add]] and [[window remove|remove]])
 +   * $windowctl(GET <​refnum>​ LASTLOG_LEVEL) \\ The filter applied to which display items get saved to the lastlog
 +   * $windowctl(GET <​refnum>​ LASTLOG_SIZE) \\ How big the lastlog really is
 +   * $windowctl(GET <​refnum>​ LASTLOG_MAX) \\ How big the lastlog can get before we start rolling off
 +   * $windowctl(GET <​refnum>​ LOGGING) \\ 0 if /[[WINDOW LOG]] OFF, 1 if /[[WINDOW LOG]] ON
 +   * $windowctl(GET <​refnum>​ LOGFILE) \\ The filename we're saving our log to.
 +   * $windowctl(GET <​refnum>​ SWAPPABLE) \\ 0 if /[[WINDOW SWAPPABLE]] OFF, 1 if /[[WINDOW SWAPPABLE]] ON
 +   * $windowctl(GET <​refnum>​ SCROLLADJ) \\ 0 if /[[WINDOW SCROLLADJ]] OFF, 1 if /[[WINDOW SCROLLADJ]] ON
 +   * $windowctl(GET <​refnum>​ DECEASED) \\ 0 until /[[ON WINDOW_BEFOREKILL]] is thrown, then 1 after that.
 +   * $windowctl(GET <​refnum>​ TOPLINES) \\ The number of toplines being displayed in this window
 +   * $windowctl(GET <​refnum>​ TOPLINE <​num>​) \\ The value of the <​num>​th topline.
 +   * $windowctl(GET <​refnum>​ DISPLAY_SIZE) \\ Height of given window refnum.
 +   * $windowctl(GET <​refnum>​ SCREEN) \\ Screen of specified visible window.
 +   * $windowctl(GET <​refnum>​ LINE <​num>​)
 +   * $windowctl(SET <​refnum>​ <​anything>​ <​anything>​) \\ Returns empty string (not implemented yet)
 +   * $windowctl(SET <​refnum>​ NOTIFY_NAME) \\ Set what will show up in %{1}F when the window is notified.
 +   * $windowctl(SET <​refnum>​ ACTIVITY_FORMAT <​number>​ <​string>​) \\ When you set it to a <​number>​ between 1 and 10, an %E expando will expand to given string, depending on CURRENT_ACTIVITY,​ which decides what ACTIVITY_FORMAT to use. String is expanded once.
 +   * $windowctl(SET <​refnum>​ CURRENT_ACTIVITY <​number>​) \\ This decides what ACTIVITY_FORMAT string to use in the %E expando. Valid values for <​number>​ are from 0 to 10, inclusive. If this is set to 0, %E expands to an empty string.
 +   * $windowctl(SET <​refnum>​ ACTIVITY_DATA <​number>​ <​string>​) \\ This sets the data to which $* will expand in ACTIVITY_FORMAT.
 +   * $windowctl(GET <​refnum>​ CURRENT_ACTIVITY) \\ Gets current activity level in specified window. Might be useful for writing multi-activity level $[[notifywindows]]() replacement,​ like the one the [[activity script]] is.
 +   * $windowctl(GET <​refnum>​ ACTIVITY_FORMAT <​number>​) \\ Gets the value of ACTIVITY_FORMAT for a specified activity level <​number>​.
 +   * $windowctl(SET <​refnum>​ ACTIVITY_DATA <​number>​) \\ Gets the data from previously saved ACTIVITY_DATA.
 +
 +======History:​======
 +The $windowctl() function first appeared in EPIC4-1.2.0 \\
 +SWAPPABLE first appeared in EPIC4-1.2.2. \\
 +TOPLINES first appeared in EPIC5-0.0.3. \\
 +ACTIVITY_* first appeared in EPIC5-0.0.6.
  
windowctl.txt ยท Last modified: 2008/04/11 23:12 (external edit)