Struct xpcom::interfaces::nsITreeView

#[repr(C)]
pub struct nsITreeView { /* fields omitted */ }

interface nsITreeView : nsISupports

Methods

impl nsITreeView

pub fn coerce<T: nsITreeViewCoerce>(&self) -> &T

Cast this nsITreeView to one of its base interfaces.

impl nsITreeView

pub const DROP_BEFORE: i64

DROP_BEFORE: i64 = -1

pub const DROP_ON: i64

DROP_ON: i64 = 0

pub const DROP_AFTER: i64

DROP_AFTER: i64 = 1

pub const PROGRESS_NORMAL: i64

PROGRESS_NORMAL: i64 = 1

/**
   * The progress mode for a given cell. This method is only called for
   * columns of type |progressmeter|.
   */

pub const PROGRESS_UNDETERMINED: i64

PROGRESS_UNDETERMINED: i64 = 2

pub const PROGRESS_NONE: i64

PROGRESS_NONE: i64 = 3

pub unsafe fn GetRowCount(&self, aRowCount: *mut int32_t) -> nsresult

/**
   * The total number of rows in the tree (including the offscreen rows).
   */

readonly attribute long rowCount;

pub unsafe fn GetSelection(
    &self,
    aSelection: *mut *const nsITreeSelection
) -> nsresult

/**
   * The selection for this view.
   */

attribute nsITreeSelection selection;

pub unsafe fn SetSelection(
    &self,
    aSelection: *const nsITreeSelection
) -> nsresult

/**
   * The selection for this view.
   */

attribute nsITreeSelection selection;

pub unsafe fn GetRowProperties(
    &self,
    index: int32_t,
    _retval: &mut nsAString
) -> nsresult

/**
   * A whitespace delimited list of properties.  For each property X the view
   * gives back will cause the pseudoclasses  ::-moz-tree-cell(x),
   * ::-moz-tree-row(x), ::-moz-tree-twisty(x), ::-moz-tree-image(x),
   * ::-moz-tree-cell-text(x).  to be matched on the pseudoelement
   * ::moz-tree-row.
   */

AString getRowProperties (in long index);

pub unsafe fn GetCellProperties(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    _retval: &mut nsAString
) -> nsresult

/**
   * A whitespace delimited list of properties for a given cell.  Each
   * property, x, that the view gives back will cause the pseudoclasses
   *  ::-moz-tree-cell(x), ::-moz-tree-row(x), ::-moz-tree-twisty(x),
   *  ::-moz-tree-image(x), ::-moz-tree-cell-text(x). to be matched on the
   *  cell.
   */

AString getCellProperties (in long row, in nsITreeColumn col);

pub unsafe fn GetColumnProperties(
    &self,
    col: *const nsITreeColumn,
    _retval: &mut nsAString
) -> nsresult

/**
   * Called to get properties to paint a column background.  For shading the sort
   * column, etc.
   */

AString getColumnProperties (in nsITreeColumn col);

pub unsafe fn IsContainer(&self, index: int32_t, _retval: *mut bool) -> nsresult

/**
   * Methods that can be used to test whether or not a twisty should be drawn,
   * and if so, whether an open or closed twisty should be used.
   */

boolean isContainer (in long index);

pub unsafe fn IsContainerOpen(
    &self,
    index: int32_t,
    _retval: *mut bool
) -> nsresult

boolean isContainerOpen (in long index);

pub unsafe fn IsContainerEmpty(
    &self,
    index: int32_t,
    _retval: *mut bool
) -> nsresult

boolean isContainerEmpty (in long index);

pub unsafe fn IsSeparator(&self, index: int32_t, _retval: *mut bool) -> nsresult

/**
   * isSeparator is used to determine if the row at index is a separator.
   * A value of true will result in the tree drawing a horizontal separator.
   * The tree uses the ::moz-tree-separator pseudoclass to draw the separator.
   */

boolean isSeparator (in long index);

pub unsafe fn IsSorted(&self, _retval: *mut bool) -> nsresult

/**
   * Specifies if there is currently a sort on any column. Used mostly by dragdrop
   * to affect drop feedback.
   */

boolean isSorted ();

pub unsafe fn CanDrop(
    &self,
    index: int32_t,
    orientation: int32_t,
    dataTransfer: *const nsIDOMDataTransfer,
    _retval: *mut bool
) -> nsresult

/**
   * Methods used by the drag feedback code to determine if a drag is allowable at
   * the current location. To get the behavior where drops are only allowed on
   * items, such as the mailNews folder pane, always return false when
   * the orientation is not DROP_ON.
   */

boolean canDrop (in long index, in long orientation, in nsIDOMDataTransfer dataTransfer);

pub unsafe fn Drop(
    &self,
    row: int32_t,
    orientation: int32_t,
    dataTransfer: *const nsIDOMDataTransfer
) -> nsresult

/**
   * Called when the user drops something on this view. The |orientation| param
   * specifies before/on/after the given |row|.
   */

void drop (in long row, in long orientation, in nsIDOMDataTransfer dataTransfer);

pub unsafe fn GetParentIndex(
    &self,
    rowIndex: int32_t,
    _retval: *mut int32_t
) -> nsresult

/**
   * Methods used by the tree to draw thread lines in the tree.
   * getParentIndex is used to obtain the index of a parent row.
   * If there is no parent row, getParentIndex returns -1.
   */

long getParentIndex (in long rowIndex);

pub unsafe fn HasNextSibling(
    &self,
    rowIndex: int32_t,
    afterIndex: int32_t,
    _retval: *mut bool
) -> nsresult

/**
   * hasNextSibling is used to determine if the row at rowIndex has a nextSibling
   * that occurs *after* the index specified by afterIndex.  Code that is forced
   * to march down the view looking at levels can optimize the march by starting
   * at afterIndex+1.
   */

boolean hasNextSibling (in long rowIndex, in long afterIndex);

pub unsafe fn GetLevel(&self, index: int32_t, _retval: *mut int32_t) -> nsresult

/**
   * The level is an integer value that represents
   * the level of indentation.  It is multiplied by the width specified in the
   * :moz-tree-indentation pseudoelement to compute the exact indendation.
   */

long getLevel (in long index);

pub unsafe fn GetImageSrc(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    _retval: &mut nsAString
) -> nsresult

/**
   * The image path for a given cell. For defining an icon for a cell.
   * If the empty string is returned, the :moz-tree-image pseudoelement
   * will be used.
   */

AString getImageSrc (in long row, in nsITreeColumn col);

pub unsafe fn GetProgressMode(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    _retval: *mut int32_t
) -> nsresult

long getProgressMode (in long row, in nsITreeColumn col);

pub unsafe fn GetCellValue(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    _retval: &mut nsAString
) -> nsresult

/**
   * The value for a given cell. This method is only called for columns
   * of type other than |text|.
   */

AString getCellValue (in long row, in nsITreeColumn col);

pub unsafe fn GetCellText(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    _retval: &mut nsAString
) -> nsresult

/**
   * The text for a given cell.  If a column consists only of an image, then
   * the empty string is returned.
   */

AString getCellText (in long row, in nsITreeColumn col);

pub unsafe fn SetTree(&self, tree: *const nsITreeBoxObject) -> nsresult

/**
   * Called during initialization to link the view to the front end box object.
   */

void setTree (in nsITreeBoxObject tree);

pub unsafe fn ToggleOpenState(&self, index: int32_t) -> nsresult

/**
   * Called on the view when an item is opened or closed.
   */

void toggleOpenState (in long index);

pub unsafe fn CycleHeader(&self, col: *const nsITreeColumn) -> nsresult

/**
   * Called on the view when a header is clicked.
   */

void cycleHeader (in nsITreeColumn col);

pub unsafe fn SelectionChanged(&self) -> nsresult

/**
   * Should be called from a XUL onselect handler whenever the selection changes.
   */

void selectionChanged ();

pub unsafe fn CycleCell(
    &self,
    row: int32_t,
    col: *const nsITreeColumn
) -> nsresult

/**
   * Called on the view when a cell in a non-selectable cycling column (e.g., unread/flag/etc.) is clicked.
   */

void cycleCell (in long row, in nsITreeColumn col);

pub unsafe fn IsEditable(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    _retval: *mut bool
) -> nsresult

/**
   * isEditable is called to ask the view if the cell contents are editable.
   * A value of true will result in the tree popping up a text field when
   * the user tries to inline edit the cell.
   */

boolean isEditable (in long row, in nsITreeColumn col);

pub unsafe fn IsSelectable(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    _retval: *mut bool
) -> nsresult

/**
   * isSelectable is called to ask the view if the cell is selectable.
   * This method is only called if the selection style is |cell| or |text|.
   * XXXvarga shouldn't this be called isCellSelectable?
   */

boolean isSelectable (in long row, in nsITreeColumn col);

pub unsafe fn SetCellValue(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    value: &nsAString
) -> nsresult

/**
   * setCellValue is called when the value of the cell has been set by the user.
   * This method is only called for columns of type other than |text|.
   */

void setCellValue (in long row, in nsITreeColumn col, in AString value);

pub unsafe fn SetCellText(
    &self,
    row: int32_t,
    col: *const nsITreeColumn,
    value: &nsAString
) -> nsresult

/**
   * setCellText is called when the contents of the cell have been edited by the user.
   */

void setCellText (in long row, in nsITreeColumn col, in AString value);

pub unsafe fn PerformAction(&self, action: *const int16_t) -> nsresult

/**
   * A command API that can be used to invoke commands on the selection.  The tree
   * will automatically invoke this method when certain keys are pressed.  For example,
   * when the DEL key is pressed, performAction will be called with the "delete" string.
   */

void performAction (in wstring action);

pub unsafe fn PerformActionOnRow(
    &self,
    action: *const int16_t,
    row: int32_t
) -> nsresult

/**
   * A command API that can be used to invoke commands on a specific row.
   */

void performActionOnRow (in wstring action, in long row);

pub unsafe fn PerformActionOnCell(
    &self,
    action: *const int16_t,
    row: int32_t,
    col: *const nsITreeColumn
) -> nsresult

/**
   * A command API that can be used to invoke commands on a specific cell.
   */

void performActionOnCell (in wstring action, in long row, in nsITreeColumn col);

Methods from Deref<Target = nsISupports>

pub fn coerce<T: nsISupportsCoerce>(&self) -> &T

Cast this nsISupports to one of its base interfaces.

pub unsafe fn QueryInterface(
    &self,
    uuid: &nsIID,
    result: *mut *mut c_void
) -> nsresult

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

pub unsafe fn AddRef(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt AddRef ();

pub unsafe fn Release(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsITreeView

const IID: nsIID

IID: nsIID = nsID(152114928, 3036, 19250, [185, 200, 200, 213, 163, 124, 176, 136])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsITreeView

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsITreeView

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.