Struct xpcom::interfaces::nsINavHistoryQueryResultNode

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

interface nsINavHistoryQueryResultNode : nsINavHistoryContainerResultNode

Methods

impl nsINavHistoryQueryResultNode

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

Cast this nsINavHistoryQueryResultNode to one of its base interfaces.

impl nsINavHistoryQueryResultNode

pub unsafe fn GetQueries(
    &self,
    queryCount: *mut uint32_t,
    queries: *mut *mut *const nsINavHistoryQuery
) -> nsresult

/**
 * Used for places queries and as a base for bookmark folders.
 *
 * Note that if you request places to *not* be expanded in the options that
 * generated this node, this item will report it has no children and never try
 * to populate itself.
 */
/**
   * Get the queries which build this node's children.
   * Only valid for RESULT_TYPE_QUERY nodes.
   */

void getQueries ([optional] out unsigned long queryCount, [array, size_is (queryCount), retval] out nsINavHistoryQuery queries);

pub unsafe fn GetQueryOptions(
    &self,
    aQueryOptions: *mut *const nsINavHistoryQueryOptions
) -> nsresult

/**
   * Get the options which group this node's children.
   * Only valid for RESULT_TYPE_QUERY nodes.
   */

readonly attribute nsINavHistoryQueryOptions queryOptions;

pub unsafe fn GetFolderItemId(&self, aFolderItemId: *mut int64_t) -> nsresult

/**
   * For both simple folder queries and folder shortcut queries, this is set to
   * the concrete itemId of the folder (i.e. for folder shortcuts it's the
   * target folder id).  Otherwise, this is set to -1.
   */

readonly attribute long long folderItemId;

pub unsafe fn GetTargetFolderGuid(
    &self,
    aTargetFolderGuid: &mut nsACString
) -> nsresult

/**
   * For both simple folder queries and folder shortcut queries, this is set to
   * the concrete guid of the folder (i.e. for folder shortcuts it's the target
   * folder guid). Otherwise, this is set to an empty string.
   */

readonly attribute ACString targetFolderGuid;

Methods from Deref<Target = nsINavHistoryContainerResultNode>

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

Cast this nsINavHistoryContainerResultNode to one of its base interfaces.

pub const STATE_CLOSED: i64

pub const STATE_LOADING: i64

pub const STATE_OPENED: i64

pub unsafe fn GetContainerOpen(&self, aContainerOpen: *mut bool) -> nsresult

/**
 * Base class for container results. This includes all types of groupings.
 * Bookmark folders and places queries will be QueryResultNodes which extends
 * these items.
 */
/**
   * Set this to allow descent into the container. When closed, attempting
   * to call getChildren or childCount will result in an error. You should
   * set this to false when you are done reading.
   *
   * For HOST and DAY groupings, doing this is free since the children have
   * been precomputed. For queries and bookmark folders, being open means they
   * will keep themselves up-to-date by listening for updates and re-querying
   * as needed.
   */

attribute boolean containerOpen;

pub unsafe fn SetContainerOpen(&self, aContainerOpen: bool) -> nsresult

/**
 * Base class for container results. This includes all types of groupings.
 * Bookmark folders and places queries will be QueryResultNodes which extends
 * these items.
 */
/**
   * Set this to allow descent into the container. When closed, attempting
   * to call getChildren or childCount will result in an error. You should
   * set this to false when you are done reading.
   *
   * For HOST and DAY groupings, doing this is free since the children have
   * been precomputed. For queries and bookmark folders, being open means they
   * will keep themselves up-to-date by listening for updates and re-querying
   * as needed.
   */

attribute boolean containerOpen;

pub unsafe fn GetState(&self, aState: *mut uint16_t) -> nsresult

/**
   * Indicates whether the container is closed, loading, or opened.  Loading
   * implies that the container has been opened asynchronously and has not yet
   * fully opened.
   */

readonly attribute unsigned short state;

pub unsafe fn GetHasChildren(&self, aHasChildren: *mut bool) -> nsresult

/**
   * This indicates whether this node "may" have children, and can be used
   * when the container is open or closed. When the container is closed, it
   * will give you an exact answer if the node can easily be populated (for
   * example, a bookmark folder). If not (for example, a complex history query),
   * it will return true. When the container is open, it will always be
   * accurate. It is intended to be used to see if we should draw the "+" next
   * to a tree item.
   */

readonly attribute boolean hasChildren;

pub unsafe fn GetChildCount(&self, aChildCount: *mut uint32_t) -> nsresult

/**
   * This gives you the children of the nodes. It is preferrable to use this
   * interface over the array one, since it avoids creating an nsIArray object
   * and the interface is already the correct type.
   *
   * @throws NS_ERROR_NOT_AVAILABLE if containerOpen is false.
   */

readonly attribute unsigned long childCount;

pub unsafe fn GetChild(
    &self,
    aIndex: uint32_t,
    _retval: *mut *const nsINavHistoryResultNode
) -> nsresult

nsINavHistoryResultNode getChild (in unsigned long aIndex);

pub unsafe fn GetChildIndex(
    &self,
    aNode: *const nsINavHistoryResultNode,
    _retval: *mut uint32_t
) -> nsresult

/**
   * Get the index of a direct child in this container.
   *
   * @param aNode
   *        a result node.
   *
   * @return aNode's index in this container.
   * @throws NS_ERROR_NOT_AVAILABLE if containerOpen is false.
   * @throws NS_ERROR_INVALID_ARG if aNode isn't a direct child of this
   * container.
   */

unsigned long getChildIndex (in nsINavHistoryResultNode aNode);

Trait Implementations

impl XpCom for nsINavHistoryQueryResultNode

const IID: nsIID

IID: nsIID = nsID(1652651865, 20462, 17571, [181, 140, 62, 47, 90, 252, 157, 10])

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 nsINavHistoryQueryResultNode

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsINavHistoryQueryResultNode

type Target = nsINavHistoryContainerResultNode

The resulting type after dereferencing.

fn deref(&self) -> &nsINavHistoryContainerResultNode

Dereferences the value.