Description of public API for ScwView
======================================

Create one like this:

C: view = g_object_new (SCW_TYPE_VIEW, NULL);

Python: view = Scw.View()

Ruby: view = Scw::View.new

Methods
========

void scw_view_scroll_to_end (ScwView *view);
view.scroll_to_end()
view.scroll_to_end

Scrolls the view to the end of the visible rows


void scw_view_set_column_foldable (ScwView *view, gint column);
view.set_column_foldable(column)
view.set_column_foldable(column)

Sets the specified column number as foldable, so that the column contents will
be drawn below the previous column's contents.
Valid column numbers start from 1 


Types
======

#define SCW_TYPE_TIMESTAMP
Scw.TYPE_TIMESTAMP
Scw::Timestamp
Derives from: Integer

A type for (user-defineable) timestamp formatting


#define SCW_TYPE_PRESENCE
Scw.TYPE_PRESENCE
Scw::Presence
Derives from: String

A type that allows uniform column-based alignment


#define SCW_TYPE_ROW_COLOR
Scw.TYPE_ROW_COLOR
Scw::RowColor
Derives from: GdkColor

A type for overriding a color in a specific row


Signals
========

"activate"
Emitted when an activatable item (defined with the <action> tag) is clicked on.
Parameters:
  action_id, the id attribute of an action tag
  action_data, the text enclosed in the <action> tag pair
  
  void    (* activate) (ScwView  *view,
                         gchar    *action_id,
                         gchar    *action_data);
  def on_activate(view, action_id, action_data)


"context-request"
Emitted when the user right-clicks (with mouse button 3) on the view.
The first two parameters will be NULL (or equivalent) if the click does not
occur on an activatable item.
Parameters:
  action_id, the id attribute of an action tag or NULL
  action_data, the text enclosed in the <action> tag pair or NULL
  x, the x coordinate for the click, relative to the widgets origin
  y, the y coordinate for the click, relative to the widgets origin

  void    (* context_request) (ScwView  *view,
                               gchar    *action_id,
                               gchar    *action_data,
                               gint     event_x,
                               gint     event_y);
  def on_context_request(view, action_id, action_data, x, y)



Properties
===========

"model"
Model
The model from which the view gets it data
Type: GtkTreeModel implementations (GtkTreeStore not fully supported)

"align-presences"
Align presence names in the view
Aligns presence names (the type ScwPresence) added to the view to take up the
same space
Type: Boolean
Default: No

"presence-alignment"
Alignment of presence names in the view
Decide which PangoAlignment type will be used for presence names (the type
ScwPresence). Only effective if "align-presences" is set.
Type: PangoAlignment
Default: Right-aligned

"scroll-on-append"
Scrolls to the end of buffer when a row is added
Scrolls the view to the end of the buffer when new row is added to the model
Type: Boolean
Default: Yes

"timestamp-format"
The format string used in timestamps
The strftime-compatible format string to be used with the timestamp columns
Type: String
Default: "<i>%H:%M</i>"

"action-attributes"
Attributes to apply for activatable text
The string used as the attribute section for the pango span tag that replaces
action tags
Type: String
Default: "underline='single'"

"selection-row-separator"
The string used to separate rows in selections
Type: String
Default: "\n"

"selection-column-separator",
The string used to separate columns in selections
Type: String
Default: " "

Style properties
==================

"alternate-row-colors"
Use alternate colors for even and odd rows
Controls whether the row colors should alternate between even and odd rows
Type: Boolean
Default: Yes

"even-row-color"
Even Row Color
Color to use for even rows, also used as the background color
Type: GdkColor
Default: base[NORMAL]

"odd-row-color"
Odd Row Color"
"Color to use for odd rows"
Type: GdkColor
Default: base[NORMAL] * "odd-row-tint" property

"odd-row-tint"
Amount of shading applied to odd rows, if the odd-row-color is not set
Value of 1 means the same color, value of 0.9 means 10% darkened color
Type: Float, range 0.0 - 1.0
Default: 0.9

"row-padding"
Padding around row contents
Amount of empty space to leave around row contents
Type: Integer, range 0 - MAX_INT
Default: 6

"column-spacing"
Space between columns
Amount of empty space to leave between columns
Type: Integer, range 0 - MAX_INT
Default: 6

Description of public API for ScwEntry
======================================

Create one like this:

C: view = g_object_new (SCW_TYPE_ENTRY, NULL);

Python: view = Scw.Entry()

Ruby: view = Scw::Entry.new

Methods
========

void
scw_entry_history_append (ScwEntry *entry,
                          const gchar    *item);
entry.history_append(item)
entry.history_append(item)

Append a history item.
Concurrent duplicates are collapsed
The entry keeps it's own copy of the data


void
scw_entry_history_step_back (ScwEntry *entry);
entry.history_step_back()
entry.history_step_back

Step back one item in history
If at the end of history, does nothing.
Updates the entry's contents
If no history item is active, appends the current text to the history


void
scw_entry_history_step_forward (ScwEntry *entry);
entry.history_step_forward()
entry.history_step_forward

Step forward one item in history


const gchar *
scw_entry_history_peek_backwards (ScwEntry *entry);
entry.history_peek_backwards()
entry.history_peek_backwards

Returns the previous history item
Does not change the history or the entry in any way
Returns a copy of the previous item, the item should be freed after use 
Returns NULL if no items are available


const gchar *
scw_entry_history_peek_forward (ScwEntry *entry);
entry.history_peek_forward()
entry.history_peek_forward

Returns the next history item
Does not change the history or the entry in any way
Returns a copy of the next item, the item should be freed after use 
Returns NULL if no items are available


Properties
===========

"history-size"
History size
Number of history items for this entry
Type: Integer, range 0 - 200
Default: 20

