Struct IListPage 

pub struct IListPage(/* private fields */);

The IListPage interface represents a page in the Command Palette that displays a list of items. It is used to present a collection of items in a structured format, allowing users to interact with and select from the list.

Implementations

impl IListPage

pub fn SearchText(&self) -> Result<HSTRING>

The text used to filter the list items. This property allows users to search for specific items within the list.

pub fn PlaceholderText(&self) -> Result<HSTRING>

The text to display when the list is empty or no items match the current filters. This property provides context to the user about the state of the list.

pub fn ShowDetails(&self) -> Result<bool>

Indicates whether to show detailed information about the items in the list. This property can be used to toggle between a summary view and a detailed view of the items.

pub fn Filters(&self) -> Result<IFilters>

The filters applied to the list. This property allows users to refine the items displayed in the list based on specific criteria.

pub fn GridProperties(&self) -> Result<IGridProperties>

The properties of the grid layout used to display the list items. This property defines how the items are arranged and presented in the grid.

pub fn HasMoreItems(&self) -> Result<bool>

Indicates whether there are more items to load in the list. This property is used to determine if additional items can be fetched or displayed.

pub fn EmptyContent(&self) -> Result<ICommandItem>

The content to display when the list is empty. This property can be used to provide a message or action for the user when there are no items to display.

pub fn GetItems(&self) -> Result<Array<IListItem>>

The GetItems method retrieves the items to be displayed in the list. This method is used to fetch the data that populates the list.

Returns

An array of IListItem containing the items to be displayed in the list. The array may be empty if there are no items to display or if the filters applied to the list result in no matching items.

pub fn LoadMore(&self) -> Result<()>

The LoadMore method is used to load additional items into the list. This method is typically called when the user requests more items, such as when scrolling to the end of the list or clicking a “Load More” button.

pub fn Name(&self) -> Result<HSTRING>

Gets the name of the command.

pub fn Id(&self) -> Result<HSTRING>

Gets the ID of the command. This is optional but can help support more efficient command lookup in ICommandProvider::GetCommand.

pub fn Icon(&self) -> Result<IIconInfo>

Gets the icon of the command.

pub fn ItemsChanged<P0>(&self, handler: P0) -> Result<i64>

where P0: Param<TypedEventHandler<IInspectable, IItemsChangedEventArgs>>,

pub fn RemoveItemsChanged(&self, token: i64) -> Result<()>

pub fn PropChanged<P0>(&self, handler: P0) -> Result<i64>

where P0: Param<TypedEventHandler<IInspectable, IPropChangedEventArgs>>,

pub fn RemovePropChanged(&self, token: i64) -> Result<()>

pub fn Title(&self) -> Result<HSTRING>

The title of the page.

pub fn IsLoading(&self) -> Result<bool>

Indicates whether the page is currently loading.

pub fn AccentColor(&self) -> Result<OptionalColor>

The accent color of the page.

Trait Implementations

impl AsImpl<DynamicListPage> for IListPage

unsafe fn as_impl_ptr(&self) -> NonNull<DynamicListPage>

Returns a pointer to the implementation object.

unsafe fn as_impl(&self) -> &T

Safety

impl AsImpl<ListPage> for IListPage

unsafe fn as_impl_ptr(&self) -> NonNull<ListPage>

Returns a pointer to the implementation object.

unsafe fn as_impl(&self) -> &T

Safety

impl CanInto<ICommand> for IListPage

const QUERY: bool = true

impl CanInto<IInspectable> for IListPage

const QUERY: bool = false

impl CanInto<IListPage> for IDynamicListPage

const QUERY: bool = true

impl CanInto<INotifyItemsChanged> for IListPage

const QUERY: bool = true

impl CanInto<INotifyPropChanged> for IListPage

const QUERY: bool = true

impl CanInto<IPage> for IListPage

const QUERY: bool = true

impl CanInto<IUnknown> for IListPage

const QUERY: bool = false

impl Clone for IListPage

fn clone(&self) -> IListPage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComObjectInterface<IListPage> for DynamicListPage_Impl

fn as_interface_ref(&self) -> InterfaceRef<'_, IListPage>

Gets a borrowed interface that is implemented by T.

impl ComObjectInterface<IListPage> for ListPage_Impl

fn as_interface_ref(&self) -> InterfaceRef<'_, IListPage>

Gets a borrowed interface that is implemented by T.

impl Debug for IListPage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for IListPage

impl From<&IListPage> for &IInspectable

fn from(value: &IListPage) -> Self

Converts to this type from the input type.

impl From<&IListPage> for &IUnknown

fn from(value: &IListPage) -> Self

Converts to this type from the input type.

impl From<DynamicListPage> for IListPage

fn from(this: DynamicListPage) -> Self

Converts to this type from the input type.

impl From<IListPage> for IInspectable

fn from(value: IListPage) -> Self

Converts to this type from the input type.

impl From<IListPage> for IUnknown

fn from(value: IListPage) -> Self

Converts to this type from the input type.

impl From<ListPage> for IListPage

fn from(this: ListPage) -> Self

Converts to this type from the input type.

impl Interface for IListPage

const IID: GUID

The GUID associated with the interface.

fn as_raw(&self) -> *mut c_void

Returns the raw COM interface pointer. The resulting pointer continues to be owned by the Interface implementation.

fn into_raw(self) -> *mut c_void

Returns the raw COM interface pointer and releases ownership. It the caller’s responsibility to release the COM interface pointer.

unsafe fn from_raw(raw: *mut c_void) -> Self

Creates an Interface by taking ownership of the raw COM interface pointer.

unsafe fn from_raw_borrowed(raw: &*mut c_void) -> Option<&Self>

Creates an Interface that is valid so long as the raw COM interface pointer is valid.

fn cast<T>(&self) -> Result<T, Error>

where T: Interface,

Attempts to cast the current interface to another interface using QueryInterface.

fn cast_to_any<T>(&self) -> Result<&(dyn Any + 'static), Error>

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

This casts the given COM interface to [&dyn Any].

fn is_object<T>(&self) -> bool

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

Returns true if the given COM interface refers to an implementation of T.

fn cast_object_ref<T>(&self) -> Result<&<T as ComObjectInner>::Outer, Error>

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

This casts the given COM interface to [&dyn Any]. It returns a reference to the “outer” object, e.g. &MyApp_Impl, not the inner &MyApp object.

fn cast_object<T>(&self) -> Result<ComObject<T>, Error>

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

This casts the given COM interface to [&dyn Any]. It returns a reference to the “outer” object, e.g. MyApp_Impl, not the inner MyApp object.

fn downgrade(&self) -> Result<Weak<Self>, Error>

Attempts to create a Weak reference to this object.

unsafe fn query(&self, iid: *const GUID, interface: *mut *mut c_void) -> HRESULT

Call QueryInterface on this interface

fn to_ref(&self) -> InterfaceRef<'_, Self>

Creates an InterfaceRef for this reference. The InterfaceRef tracks lifetimes statically, and eliminates the need for dynamic reference count adjustments (AddRef/Release).

impl PartialEq for IListPage

fn eq(&self, other: &IListPage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IListPage