wow/libmoduledbshare-1-0: LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua comparison

comparison LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua @ 44:9e1b25004509 v1.3 release

Added GetSecondaryCommands() function.

author	Andrew Knoll <andrewtknoll@gmail.com>
date	Wed, 10 Apr 2013 15:54:33 -0400
parents	288987af9e66
children	eb3383e30b5e

comparison

equal deleted inserted replaced

-:288987af9e66
+:9e1b25004509
 -- \\
 -- **Slash Command Support**\\
 -- LibModuleDBShare can associate a slash command with a DBGroup. The default handler function
 -- for the slash command opens the root options panel.\\
 -- Additional handler functions can be registered to respond to specific arguments given to the
--- slash command.
+-- slash command. If you provide a custom handler function for the slash command, that function
+-- is responsible for detecting secondary commands.
 --
 -- @usage
 -- local database;
 -- -- this function is called after the ADDON_LOADED event fires
 -- function initializeDB()
 -- @paramsig groupName, groupDescription, initialDB[, usesDualSpec]
 -- @param groupName The name of the new DB group, as shown in the options panel. (string)
 -- @param groupDescription A description of the group to be shown in the root options panel. (string)
 -- @param initialDB The first DB to add to the group. (table)
 -- @param usesDualSpec True if this group should use LibDualSpec, false otherwise. (boolean or nil)
--- @return the new DB group object
+-- @return the new DB group object (table)
 function LibModuleDBShare:NewGroup(groupName, groupDescription, initialDB, usesDualSpec)
 	-- check to see if LibDualSpec has been loaded
 	if not LibDualSpec then
 		LibDualSpec = LibStub("LibDualSpec-1.0", true);
 	end
 	return group;
 end
 --- Retrieves an existing DB group.
 -- @param groupName The name of the DB group to retrieve. (string)
--- @return the DB group object, or ##nil## if not found
+-- @return the DB group object, or ##nil## if not found (table)
 function LibModuleDBShare:GetGroup(groupName)
 	if type(groupName) ~= "string" then
 		error("Usage: LibModuleDBShare:GetGroup(groupName): 'groupName' must be a string.", 2);
 	end
 	return LibModuleDBShare.groups[groupName];
 end
 -- LibDualSpec support
 --- Checks to see if this group uses LibDualSpec.
--- @return ##true## if this group uses LibDualSpec, ##false## otherwise
+-- @return ##true## if this group uses LibDualSpec, ##false## otherwise (boolean)
 function DBGroup:IsUsingDualSpec()
 	return self.usesDualSpec;
 end
 --- Enables dual spec support if not already enabled.
 		end;
 	end
 end
 --- Checks to see if this group has a slash command.
--- @return ##true## if this group has a slash command, ##false## otherwise
+-- @return ##true## if this group has a slash command, ##false## otherwise (boolean)
 function DBGroup:HasSlashCommand()
 	if self.slug then
 		return true;
 	else
 		return false;
 	end
 	self.subCmdList[name] = handler;
 end
+--- Returns the list of secondary commands registered with this group.
+-- @return A table containing name-function pairs for secondary commands. (table)
+function DBGroup:GetSecondaryCommands()
+	if not self.slug then
+		error("Usage: DBGroup:GetSecondaryCommands(): Slash commands for this group have not been enabled", 2);
+	end
+	return self.subCmdList;
+end
 -- callback handlers (new profiles are handled by OnProfileChanged)
 function DBGroup:OnProfileChanged(callback, syncDB, profile)
 	if not self.squelchCallbacks then
 		for db, _ in pairs(self.members) do

Mercurial > wow > libmoduledbshare-1-0

comparison LibModuleDBShare-1.0/LibModuleDBShare-1.0.lua @ 44:9e1b25004509 v1.3 release