Struct winsafe::HMENU

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

Handle to a menu.

Implementations

impl HMENU

pub const NULL: Self

The null, invalid handle.

This constant is common to all handle types.

pub unsafe fn from_ptr<T>(p: *mut T) -> HMENU

Creates a new handle instance by wrapping a pointer.

This method is common to all handle types.

pub unsafe fn as_ptr(self) -> *mut c_void

Consumes the handle returning the underlying raw pointer.

This method is common to all handle types.

pub fn is_null(self) -> bool

Tells if the handle is invalid (null).

This method is common to all handle types.

pub fn as_opt(self) -> Option<HMENU>

Consumes the handle into an option, which is None if the handle pointer is null.

This method is common to all handle types.

impl HMENU

pub fn AppendMenu(
    self,
    flags: MF,
    new_item: IdMenu,
    content: BmpPtrStr
) -> WinResult<()>

AppendMenu method.

This method is rather tricky, consider using HMENU::AppendMenuEnum.

pub fn AppendMenuEnum(self, items: &[MenuEnum<'_>]) -> WinResult<()>

A more convenient HMENU::AppendMenu.

Examples

Adding multiple entries at once, with their command IDs:

use winsafe::{HMENU, MenuEnum};

let my_hmenu: HMENU; // initialized somewhere

const ID_FILE_OPEN: i32 = 2001;
const ID_FILE_SAVE: i32 = 2002;
const ID_FILE_EXIT: i32 = 2003;

my_hmenu.AppendMenuEnum(&[
    MenuEnum::Entry(ID_FILE_OPEN, "&Open"),
    MenuEnum::Entry(ID_FILE_OPEN, "&Save"),
    MenuEnum::Separator,
    MenuEnum::Entry(ID_FILE_EXIT, "E&xit"),
])?;

pub fn CheckMenuItem(self, id_or_pos: IdPos, check: bool) -> WinResult<MF>

CheckMenuItem method.

pub fn CheckMenuRadioItem(
    self,
    first: IdPos,
    last: IdPos,
    check: IdPos
) -> WinResult<()>

CheckMenuRadioItem method.

Panics

Panics if first, last and check don’t use the same enum field.

pub fn CreateMenu() -> WinResult<HMENU>

CreateMenu static method.

Note: If not attached to a window, must be paired with an HMENU::DestroyMenu call.

pub fn CreatePopupMenu() -> WinResult<HMENU>

CreatePopupMenu static method.

Note: If not attached to a window, must be paired with an HMENU::DestroyMenu call.

pub fn DeleteMenu(self, id_or_pos: IdPos) -> WinResult<()>

DeleteMenu method.

pub fn DestroyMenu(self) -> WinResult<()>

DestroyMenu method.

pub fn EnableMenuItem(self, id_or_pos: IdPos, enable: bool) -> WinResult<MF>

EnableMenuItem method.

Examples

Disabling a menu item:

use winsafe::{HMENU, IdPos};

const ID_FILE_OPEN: i32 = 101;

let hmenu: HMENU; // initialized somewhere

hmenu.EnableMenuItem(
    IdPos::Id(ID_FILE_OPEN),
    false,
)?;

Disabling multiple menu items at once:

use winsafe::{HMENU, IdPos};

const ID_FILE_OPEN: i32 = 201;
const ID_FILE_SAVE: i32 = 202;

let hmenu: HMENU; // initialized somewhere

[
    (ID_FILE_OPEN, "Open\tCtrl+O"),
    (ID_FILE_SAVE, "&Save"),
].iter()
    .map(|(id, txt)| hmenu.EnableMenuItem(
        IdPos::Id(*id),
        false,
    ))
    .collect::<Result<Vec<_>, _>>()?;

pub fn GetMenuDefaultItem(self, by_pos: bool, flags: GMDI) -> WinResult<IdPos>

GetMenuDefaultItem method.

pub fn GetMenuInfo(self, mi: &mut MENUINFO) -> WinResult<()>

GetMenuInfo method.

pub fn GetMenuItemCount(self) -> WinResult<u32>

GetMenuItemCount method.

pub fn GetMenuItemInfo(
    self,
    id_or_pos: IdPos,
    mii: &mut MENUITEMINFO
) -> WinResult<()>

GetMenuItemInfo method.

pub fn GetMenuItemID(self, nPos: i32) -> Option<i32>

GetMenuItemID method.

pub fn GetMenuState(self, id_or_pos: IdPos) -> WinResult<MF>

GetMenuState method.

pub fn GetMenuString(self, id_or_pos: IdPos) -> WinResult<String>

GetMenuString method.

pub fn GetSubMenu(self, pos: u32) -> Option<HMENU>

GetSubMenu method.

pub fn InsertMenuItem(
    self,
    id_or_pos: IdPos,
    mii: &MENUITEMINFO
) -> WinResult<()>

InsertMenuItem method.

pub fn IsMenu(self) -> bool

IsMenu method.

pub fn RemoveMenu(self, id_or_pos: IdPos) -> WinResult<()>

RemoveMenu method.

pub fn SetMenuDefaultItem(self, id_or_pos: IdPos) -> WinResult<()>

SetMenuDefaultItem method.

pub fn SetMenuInfo(self, mi: &MENUINFO) -> WinResult<()>

SetMenuInfo method.

pub fn SetMenuItemBitmaps(
    self,
    id_or_pos: IdPos,
    hbmp_unchecked: Option<HBITMAP>,
    hbmp_checked: Option<HBITMAP>
) -> WinResult<()>

SetMenuItemBitmaps method.

pub fn SetMenuItemInfo(
    self,
    id_or_pos: IdPos,
    mii: &MENUITEMINFO
) -> WinResult<()>

SetMenuItemInfo method.

pub fn TrackPopupMenu(
    self,
    flags: TPM,
    location: POINT,
    hwnd: HWND
) -> WinResult<Option<i32>>

TrackPopupMenu method.

Note: If you just want to display a popup menu, consider the simpler HMENU::TrackPopupMenuAtPoint.

pub fn TrackPopupMenuAtPoint(
    self,
    pos: POINT,
    hwnd_parent: HWND,
    hwnd_coords_relative_to: HWND
) -> WinResult<()>

Shows the popup menu anchored at the given coordinates using TrackPopupMenu, and performs other needed operations.

This method will block until the menu disappears.

Trait Implementations

impl Binary for HMENU

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

Formats the value using the given formatter.

impl Clone for HMENU

fn clone(&self) -> HMENU

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HMENU

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

Formats the value using the given formatter.

impl Display for HMENU

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

Formats the value using the given formatter.

impl LowerHex for HMENU

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

Formats the value using the given formatter.

impl Octal for HMENU

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

Formats the value using the given formatter.

impl PartialEq<HMENU> for HMENU

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl UpperHex for HMENU

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

Formats the value using the given formatter.

impl Copy for HMENU

impl Eq for HMENU

impl Send for HMENU

impl StructuralEq for HMENU

impl StructuralPartialEq for HMENU

impl Sync for HMENU