Improve docs on defined_names

This commit is contained in:
snippet 2022-11-13 13:30:18 +11:00
parent ccad2fb646
commit ad0528ae1b

View File

@ -73,18 +73,18 @@ struct defined_name
}
// Implements (most of) CT_RevisionDefinedName, there's several "old" members in the spec but they're also ignored in other librarie
std::string name;
optional<std::string> comment;
optional<std::string> custom_menu;
optional<std::string> description;
optional<std::string> help;
optional<std::string> status_bar;
optional<std::size_t> sheet_id; // 0 indexed.
optional<bool> hidden;
optional<bool> function;
optional<std::size_t> function_group_id;
optional<std::string> shortcut_key; // This is unsigned byte in the spec, but openpyxl uses string so let's try that
std::string value;
std::string name; // A string representing the name for this defined name.
optional<std::string> comment; // A string representing a comment about the defined name.
optional<std::string> custom_menu; // A string representing the new custom menu text
optional<std::string> description; // A string representing the new description text for the defined name.
optional<std::string> help; // A string representing the new help topic text.
optional<std::string> status_bar; // A string representing the new status bar text.
optional<std::size_t> sheet_id; // An integer representing the id of the sheet to which this defined name belongs. This shall be used local defined names only. 0 indexed indexed.
optional<bool> hidden; // A Boolean value indicating whether the named range is now hidden.
optional<bool> function; // A Boolean value indicating that the defined name refers to a function. True if the defined name is a function, false otherwise.
optional<std::size_t> function_group_id;// Represents the new function group id.
optional<std::string> shortcut_key; // Represents the new keyboard shortcut. This is unsigned byte in the spec, but openpyxl uses string so let's try that
std::string value; // The actual value of the name, ie "='Sheet1'!A1"
};