File size: 6,082 Bytes
adb87a5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | import { MenuItemBase } from './base';
import { type MenuItemOptions } from '../menu';
import { MenuIcon } from '../image';
/**
* A native Icon to be used for the menu item
*
* #### Platform-specific:
*
* - **Windows / Linux**: Unsupported.
*/
export declare enum NativeIcon {
/** An add item template image. */
Add = "Add",
/** Advanced preferences toolbar icon for the preferences window. */
Advanced = "Advanced",
/** A Bluetooth template image. */
Bluetooth = "Bluetooth",
/** Bookmarks image suitable for a template. */
Bookmarks = "Bookmarks",
/** A caution image. */
Caution = "Caution",
/** A color panel toolbar icon. */
ColorPanel = "ColorPanel",
/** A column view mode template image. */
ColumnView = "ColumnView",
/** A computer icon. */
Computer = "Computer",
/** An enter full-screen mode template image. */
EnterFullScreen = "EnterFullScreen",
/** Permissions for all users. */
Everyone = "Everyone",
/** An exit full-screen mode template image. */
ExitFullScreen = "ExitFullScreen",
/** A cover flow view mode template image. */
FlowView = "FlowView",
/** A folder image. */
Folder = "Folder",
/** A burnable folder icon. */
FolderBurnable = "FolderBurnable",
/** A smart folder icon. */
FolderSmart = "FolderSmart",
/** A link template image. */
FollowLinkFreestanding = "FollowLinkFreestanding",
/** A font panel toolbar icon. */
FontPanel = "FontPanel",
/** A `go back` template image. */
GoLeft = "GoLeft",
/** A `go forward` template image. */
GoRight = "GoRight",
/** Home image suitable for a template. */
Home = "Home",
/** An iChat Theater template image. */
IChatTheater = "IChatTheater",
/** An icon view mode template image. */
IconView = "IconView",
/** An information toolbar icon. */
Info = "Info",
/** A template image used to denote invalid data. */
InvalidDataFreestanding = "InvalidDataFreestanding",
/** A generic left-facing triangle template image. */
LeftFacingTriangle = "LeftFacingTriangle",
/** A list view mode template image. */
ListView = "ListView",
/** A locked padlock template image. */
LockLocked = "LockLocked",
/** An unlocked padlock template image. */
LockUnlocked = "LockUnlocked",
/** A horizontal dash, for use in menus. */
MenuMixedState = "MenuMixedState",
/** A check mark template image, for use in menus. */
MenuOnState = "MenuOnState",
/** A MobileMe icon. */
MobileMe = "MobileMe",
/** A drag image for multiple items. */
MultipleDocuments = "MultipleDocuments",
/** A network icon. */
Network = "Network",
/** A path button template image. */
Path = "Path",
/** General preferences toolbar icon for the preferences window. */
PreferencesGeneral = "PreferencesGeneral",
/** A Quick Look template image. */
QuickLook = "QuickLook",
/** A refresh template image. */
RefreshFreestanding = "RefreshFreestanding",
/** A refresh template image. */
Refresh = "Refresh",
/** A remove item template image. */
Remove = "Remove",
/** A reveal contents template image. */
RevealFreestanding = "RevealFreestanding",
/** A generic right-facing triangle template image. */
RightFacingTriangle = "RightFacingTriangle",
/** A share view template image. */
Share = "Share",
/** A slideshow template image. */
Slideshow = "Slideshow",
/** A badge for a `smart` item. */
SmartBadge = "SmartBadge",
/** Small green indicator, similar to iChat's available image. */
StatusAvailable = "StatusAvailable",
/** Small clear indicator. */
StatusNone = "StatusNone",
/** Small yellow indicator, similar to iChat's idle image. */
StatusPartiallyAvailable = "StatusPartiallyAvailable",
/** Small red indicator, similar to iChat's unavailable image. */
StatusUnavailable = "StatusUnavailable",
/** A stop progress template image. */
StopProgressFreestanding = "StopProgressFreestanding",
/** A stop progress button template image. */
StopProgress = "StopProgress",
/** An image of the empty trash can. */
TrashEmpty = "TrashEmpty",
/** An image of the full trash can. */
TrashFull = "TrashFull",
/** Permissions for a single user. */
User = "User",
/** User account toolbar icon for the preferences window. */
UserAccounts = "UserAccounts",
/** Permissions for a group of users. */
UserGroup = "UserGroup",
/** Permissions for guests. */
UserGuest = "UserGuest"
}
/** Options for creating a new icon menu item. */
export interface IconMenuItemOptions extends MenuItemOptions {
/**
* Icon to be used for the new icon menu item.
*
* Note that you may need the `image-ico` or `image-png` Cargo features to use this API.
* To enable it, change your Cargo.toml file:
* ```toml
* [dependencies]
* tauri = { version = "...", features = ["...", "image-png"] }
* ```
*/
icon?: MenuIcon;
}
/**
* An icon menu item inside a {@linkcode Menu} or {@linkcode Submenu}
* and usually contains an icon and a text.
*/
export declare class IconMenuItem extends MenuItemBase {
/** @ignore */
protected constructor(rid: number, id: string);
/** Create a new icon menu item. */
static new(opts: IconMenuItemOptions): Promise<IconMenuItem>;
/** Returns the text of this icon menu item. */
text(): Promise<string>;
/** Sets the text for this icon menu item. */
setText(text: string): Promise<void>;
/** Returns whether this icon menu item is enabled or not. */
isEnabled(): Promise<boolean>;
/** Sets whether this icon menu item is enabled or not. */
setEnabled(enabled: boolean): Promise<void>;
/** Sets the accelerator for this icon menu item. */
setAccelerator(accelerator: string | null): Promise<void>;
/** Sets an icon for this icon menu item */
setIcon(icon: MenuIcon | null): Promise<void>;
}
|