Foxit PDF SDK  9.1
FSMenuItemConfig Class Reference
Inheritance diagram for FSMenuItemConfig:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithMenu_item_config:
 Constructor, with another menu item config object.
More...
 
(id) - initWithName:user:parent:pos:pos_str:exec:enable:marked:
 Constructor, with parameters.
More...
 
(void) - set:user:parent:pos:pos_str:exec:enable:marked:
 Set values.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

NSString * enable
 (Only used by
More...
 
NSString * exec
 (Only used by
More...
 
NSString * marked
 (Only used by
More...
 
NSString * name
 The language-independent name of the menu item.
More...
 
NSString * parent
 The name of the parent menu item. Its submenu will have the new menu item added to it.
More...
 
int pos
 The position within the submenu to locate the new menu item.
More...
 
NSString * pos_str
 (Only used by
More...
 
NSString * user
 The user string (language-dependent name) to display as the menu item name.
More...
 

Detailed Description

This class represents menu item config.

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithMenu_item_config:

- (id) initWithMenu_item_config: (FSMenuItemConfig*)  menu_item_config

Constructor, with another menu item config object.

Parameters
[in]menu_item_configAnother menu item config object.

◆ initWithName:user:parent:pos:pos_str:exec:enable:marked:

- (id) initWithName: (NSString *)  name
user: (NSString *)  user
parent: (NSString *)  parent
pos: (int)  pos
pos_str: (NSString *)  pos_str
exec: (NSString *)  exec
enable: (NSString *)  enable
marked: (NSString *)  marked 

Constructor, with parameters.

Parameters
[in]nameThe language-independent name of the menu item.
[in]userThe user string (language-dependent name) to display as the menu item name.
[in]parentThe name of the parent menu item. Its submenu will have the new menu item added to it.
[in]posThe position within the submenu to locate the new menu item.
[in]pos_strThe string is a named item in the menu (a language-independent name of a menu item).
[in]execAn expression string to evaluate when the menu item is selected by the user.
[in]enableAn expression string that is evaluated to determine whether to enable the menu item.
[in]markedAn expression string that determines whether the menu item has a check mark next to it.

◆ set:user:parent:pos:pos_str:exec:enable:marked:

- (void) set: (NSString *)  name
user: (NSString *)  user
parent: (NSString *)  parent
pos: (int)  pos
pos_str: (NSString *)  pos_str
exec: (NSString *)  exec
enable: (NSString *)  enable
marked: (NSString *)  marked 

Set values.

Parameters
[in]nameThe language-independent name of the menu item.
[in]userThe user string (language-dependent name) to display as the menu item name.
[in]parentThe name of the parent menu item. Its submenu will have the new menu item added to it.
[in]posThe position within the submenu to locate the new menu item.
[in]pos_strThe string is a named item in the menu (a language-independent name of a menu item).
[in]execAn expression string to evaluate when the menu item is selected by the user.
[in]enableAn expression string that is evaluated to determine whether to enable the menu item.
[in]markedAn expression string that determines whether the menu item has a check mark next to it.
Returns
None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ enable

- (NSString *) enable
readwritenonatomiccopy

(Only used by

◆ exec

- (NSString *) exec
readwritenonatomiccopy

(Only used by

◆ marked

- (NSString *) marked
readwritenonatomiccopy

(Only used by

◆ name

- (NSString *) name
readwritenonatomiccopy

The language-independent name of the menu item.

◆ parent

- (NSString *) parent
readwritenonatomiccopy

The name of the parent menu item. Its submenu will have the new menu item added to it.

◆ pos

- (int) pos
readwritenonatomicassign

The position within the submenu to locate the new menu item.

◆ pos_str

- (NSString *) pos_str
readwritenonatomiccopy

(Only used by

◆ user

- (NSString *) user
readwritenonatomiccopy

The user string (language-dependent name) to display as the menu item name.